Class GroupHandle
java.lang.Object
org.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.GroupHandle
- All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel,org.eclipse.birt.report.model.elements.interfaces.IGroupElementModel
- Direct Known Subclasses:
ListGroupHandle,TableGroupHandle
public abstract class GroupHandle
extends ReportElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.IGroupElementModel
Represents both list and table groups in the design. Groups provide a way of
showing common headings for a group of related rows.
A group is defined by a group key. The key is a column from the query. If the group key is a time field then user often want to group on an interval such as month or quarter.
- See Also:
-
GroupElementSlotHandle
-
Field Summary
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
elementFields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
moduleFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROPFields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IGroupElementModel
ACL_EXPRESSION_PROP, BOOKMARK_DISPLAY_NAME_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, FILTER_PROP, FOOTER_SLOT, GROUP_NAME_PROP, GROUP_START_PROP, HEADER_SLOT, HIDE_DETAIL_PROP, INTERVAL_BASE_PROP, INTERVAL_PROP, INTERVAL_RANGE_PROP, KEY_EXPR_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, REPEAT_HEADER_PROP, SHOW_DETAIL_FILTER_PROP, SLOT_COUNT, SORT_DIRECTION_PROP, SORT_PROP, SORT_TYPE_PROP, TOC_PROP -
Constructor Summary
ConstructorsConstructorDescriptionGroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs a group handle with the given design and the design element. -
Method Summary
Modifier and TypeMethodDescriptionaddColumnBinding(ComputedColumn addColumn, boolean inForce) Deprecated.since BIRT 2.1 RC2Adds toc structure.Adds toc structure.booleanReturnstrue(the default), a report element's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs.Deprecated.since BIRT 2.1 RC2Returns an iterator for the filter list defined on the group.Returns the ACL expression associated with the report element instance.Returns the bookmark of listing group.Gets the display name of the bookmark.Deprecated.since BIRT 2.1 RC2Returns the footer slot.Deprecated.Returns the header slot in the group.Returns the interval of this group.Return the interval base property value of this group.doubleReturns the interval range of this group.Gets the expression that defines the group.getName()Gets the name of the group.Gets the onCreate script of the group element.Gets the on-pageBreak script of the group element.Gets the on-prepare script of the group.Gets the onRender script of the group element.Gets page break after property value of this group.Gets page break before property value of this group.Gets page break inside property value of this group.Returns the sort direction of this group.Return the sort type.getTOC()Gets TOC handle.Deprecated.booleanChecks whether the group footer slot is empty.booleanChecks whether the group header slot is empty.booleanTests whether to hide the detail rows of this group.booleanTests whether to repeat the headings at the top of each page.voidsetACLExpression(String expr) Sets the ACL expression associated with the report element instance.voidsetBookmark(String value) Sets the bookmark of listing group.voidsetBookmarkDisplayName(String bookmarkDisplayName) Sets the display name of the bookmark.voidsetCascadeACL(boolean cascadeACL) Sets the flag to control whether to cascade ACLvoidsetGroupStart(String groupStart) Deprecated.voidsetHideDetail(boolean value) Sets whether to hide the detail rows of this group.voidsetInterval(String interval) Returns the interval of this group.voidsetIntervalBase(String intervalBase) Sets the base of the interval property of this group.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into groups.voidsetIntervalRange(double intervalRange) Returns the interval range of this group.voidsetIntervalRange(String intervalRange) Sets the interval range of group.voidsetKeyExpr(String expr) Sets the group expression.voidSets the group name.voidsetOnCreate(String script) Sets create property value of this group.voidsetOnPageBreak(String script) Sets the on-pageBreak script of the group element.voidsetOnPrepare(String script) Sets the on-prepare script of the group element.voidsetOnRender(String script) Sets render property value of this group.voidsetPageBreakAfter(String value) Sets page break after property value of this group.voidsetPageBreakBefore(String value) Sets page break before property value of this group.voidsetPageBreakInside(String value) Sets page break inside property value of this group.voidsetRepeatHeader(boolean value) Sets whether to repeat the headings at the top of each page.voidsetShowDetailFilter(boolean showDetailFilter) Sets the flag which indicates whether to show the detail filter or not.voidsetSortDirection(String direction) Sets the sort direction of this group.voidsetSortType(String sortType) Sets the sort type, which indicates the way of sortingvoidsetTocExpression(String expression) Deprecated.booleanGets the flag which indicates whether to show the detail filter or not.Returns the iterator for Sort list defined on the group.Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMaskMethods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
-
Constructor Details
-
GroupHandle
public GroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs a group handle with the given design and the design element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.- Parameters:
module- the moduleelement- the model representation of the element
-
-
Method Details
-
getHeader
Returns the header slot in the group. The header slot represents subsections that print at the start of the group.- Returns:
- a slot handle to the header
-
getKeyExpr
Gets the expression that defines the group. This is normally simply a reference to a data set column.- Returns:
- the expression as a string
- See Also:
-
getName
Gets the name of the group.- Overrides:
getNamein classDesignElementHandle- Returns:
- the name of the group
-
setName
Sets the group name.- Overrides:
setNamein classDesignElementHandle- Parameters:
theName- the group name to set- Throws:
NameException- if the name is duplicate, or if the name isnulland this element requires a name.
-
setKeyExpr
Sets the group expression.- Parameters:
expr- the expression to set- Throws:
SemanticException- If the expression is invalid.- See Also:
-
sortsIterator
Returns the iterator for Sort list defined on the group. The element in the iterator is the correspondingStructureHandle.- Returns:
- the iterator for
SortKeystructure list defined on the group.
-
filtersIterator
Returns an iterator for the filter list defined on the group. Each object returned is of typeStructureHandle.- Returns:
- the iterator for
FilterCondstructure list defined on the group.
-
setGroupStart
Deprecated.Sets group start property of this group. Group start, in conjunction with Interval and IntervalRange, determines how data is divided into groups.- Parameters:
groupStart- group start property value.- Throws:
SemanticException- if the property is locked.
-
getGroupStart
Deprecated.Return the group start property value of this group.- Returns:
- group start property value of this group.
-
setIntervalBase
Sets the base of the interval property of this group.IntervalBase, in conjunction with Interval and IntervalRange, determines how data is divided into groups.- Parameters:
intervalBase- interval base property value.- Throws:
SemanticException- if the property is locked.
-
getIntervalBase
Return the interval base property value of this group.- Returns:
- interval baseF property value of this group.
-
getInterval
Returns the interval of this group. The return value is defined inDesignChoiceConstantsand can be one of:INTERVAL_NONEINTERVAL_PREFIXINTERVAL_YEARINTERVAL_QUARTERINTERVAL_MONTHINTERVAL_WEEKINTERVAL_DAYINTERVAL_HOURINTERVAL_MINUTEINTERVAL_SECONDINTERVAL_INTERVAL
- Returns:
- the interval value as a string
-
setInterval
Returns the interval of this group. The input value is defined inDesignChoiceConstantsand can be one of:INTERVAL_NONEINTERVAL_PREFIXINTERVAL_YEARINTERVAL_QUARTERINTERVAL_MONTHINTERVAL_WEEKINTERVAL_DAYINTERVAL_HOURINTERVAL_MINUTEINTERVAL_SECONDINTERVAL_INTERVAL
- Parameters:
interval- the interval value as a string- Throws:
SemanticException- if the property is locked or the input value is not one of the above.
-
getIntervalRange
public double getIntervalRange()Returns the interval range of this group.- Returns:
- the interval range value as a double
-
setIntervalRange
Returns the interval range of this group.- Parameters:
intervalRange- the interval range value as a double- Throws:
SemanticException- if the property is locked.
-
setIntervalRange
Sets the interval range of group.- Parameters:
intervalRange- the interval range value as a string.value is locale dependent.- Throws:
SemanticException- if the property is locked.
-
getSortDirection
Returns the sort direction of this group. The return value is defined inDesignChoiceConstantsand can be one of:SORT_DIRECTION_ASCSORT_DIRECTION_DESC
- Returns:
- the sort direction of this group
-
setSortDirection
Sets the sort direction of this group. The return value is defined inDesignChoiceConstantsand can be one of:SORT_DIRECTION_ASCSORT_DIRECTION_DESC
- Parameters:
direction- the sort direction of this group- Throws:
SemanticException- if the property is locked or the input value is not one of the above.
-
hasHeader
public boolean hasHeader()Checks whether the group header slot is empty.- Returns:
- true is the header slot is not empty, otherwise, return false.
-
setTocExpression
Deprecated.Sets a table of contents entry for this item. The TOC property defines an expression that returns a string that is to appear in the Table of Contents for this item or its container.- Parameters:
expression- the expression that returns a string- Throws:
SemanticException- if the TOC property is locked by the property mask.- See Also:
-
getTocExpression
Deprecated.Returns the expression evalueated as a table of contents entry for this item.- Returns:
- the expression evaluated as a table of contents entry for this item
- See Also:
-
setSortType
Sets the sort type, which indicates the way of sorting- Parameters:
sortType- sort type.- Throws:
SemanticException- if the property is locked.
-
getSortType
Return the sort type.- Returns:
- the sort type.
-
getOnPrepare
Gets the on-prepare script of the group. Startup phase. No data binding yet. The design of an element can be changed here.- Returns:
- the on-prepare script of the group
-
setOnPrepare
Sets the on-prepare script of the group element.- Parameters:
script- the script to set- Throws:
SemanticException- if the method is locked.- See Also:
-
repeatHeader
public boolean repeatHeader()Tests whether to repeat the headings at the top of each page.- Returns:
trueif repeat the headings, otherwisefalse.
-
setRepeatHeader
Sets whether to repeat the headings at the top of each page.- Parameters:
value-trueif repeat the headings, otherwisefalse.- Throws:
SemanticException- if the property is locked.
-
getPageBreakAfter
Gets page break after property value of this group.- Returns:
- page break after property value of this group.
-
setPageBreakAfter
Sets page break after property value of this group.- Parameters:
value- value of page break after property- Throws:
SemanticException- if the property is locked.
-
getPageBreakInside
Gets page break inside property value of this group.- Returns:
- page break inside property value of this group.
-
setPageBreakInside
Sets page break inside property value of this group.- Parameters:
value- value of page break inside property- Throws:
SemanticException- if the property is locked.
-
getPageBreakBefore
Gets page break before property value of this group.- Returns:
- page break before property value of this group.
-
setPageBreakBefore
Sets page break before property value of this group.- Parameters:
value- value of page break before property- Throws:
SemanticException- if the property is locked.
-
hideDetail
public boolean hideDetail()Tests whether to hide the detail rows of this group.- Returns:
trueif hide the detail rows, otherwisefalse.
-
setHideDetail
Sets whether to hide the detail rows of this group.- Parameters:
value-trueif hide the detail rows, otherwisefalse.- Throws:
SemanticException- if the property is locked.
-
getOnPageBreak
Gets the on-pageBreak script of the group element. Presentation phase. It is for a script executed when the element is prepared for page breaking in the Presentation engine.- Returns:
- the on-pageBreak script of the group element
-
setOnPageBreak
Sets the on-pageBreak script of the group element.- Parameters:
script- the script to set- Throws:
SemanticException- if the method is locked.- See Also:
-
getOnCreate
Gets the onCreate script of the group element. Presentation phase. It is for a script executed when the element is prepared for creating in the Presentation engine.- Returns:
- the onCreate script of the group element
-
setOnCreate
Sets create property value of this group.- Parameters:
value- value of create property- Throws:
SemanticException- if the property is locked.
-
getOnRender
Gets the onRender script of the group element. Presentation phase. It is for a script executed when the element is prepared for rendering in the Presentation engine.- Returns:
- the onCreate script of the group element
-
setOnRender
Sets render property value of this group.- Parameters:
value- value of render property- Throws:
SemanticException- if the property is locked.
-
columnBindingsIterator
Deprecated.since BIRT 2.1 RC2Returns the bound columns that binds the data set columns. The item in the iterator is the correspondingComputedColumnHandle.- Returns:
- a list containing the bound columns.
-
getColumnBindings
Deprecated.since BIRT 2.1 RC2Get a handle to deal with the bound column.- Returns:
- a handle to deal with the boudn data column.
-
addColumnBinding
@Deprecated public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn, boolean inForce) throws SemanticException Deprecated.since BIRT 2.1 RC2Adds a bound column to the list.- Parameters:
addColumn- the bound column to addinForce-truethe column is added to the list regardless of duplicate expression.falsedo not add the column if the expression already existcolumn- the bound column- Returns:
- the newly created
ComputedColumnHandleor the existedComputedColumnHandlein the list - Throws:
SemanticException- if expression is not duplicate but the name duplicates the exsiting bound column. Or, if the both name/expression are duplicate, butinForceistrue.
-
getTOC
Gets TOC handle.- Returns:
- toc handle
-
addTOC
Adds toc structure.- Parameters:
expression- toc expression- Returns:
- toc handle
- Throws:
SemanticException
-
addTOC
Adds toc structure.- Parameters:
toc- toc structure- Returns:
- toc handle
- Throws:
SemanticException
-
getBookmark
Returns the bookmark of listing group.- Returns:
- the book mark as a string
-
setBookmark
Sets the bookmark of listing group.- Parameters:
value- the property value to be set.- Throws:
SemanticException- if the property is locked.
-
getACLExpression
Returns the ACL expression associated with the report element instance.- Returns:
- the expression in string
-
setACLExpression
Sets the ACL expression associated with the report element instance.- Parameters:
expr- the expression in string- Throws:
SemanticException- if the property is locked by masks
-
cascadeACL
public boolean cascadeACL()Returnstrue(the default), a report element's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs. Otherwisefalse.- Returns:
- the flag to control whether to cascade ACL
-
setCascadeACL
Sets the flag to control whether to cascade ACL- Parameters:
cascadeACL-true(the default), a report element's ACL is automatically propagated to all its directly contained child elements and are added to their ACLs. Otherwisefalse.- Throws:
SemanticException- if the property is locked by masks
-
getBookmarkDisplayName
Gets the display name of the bookmark.- Returns:
- the display name of the bookmark.
-
setBookmarkDisplayName
Sets the display name of the bookmark.- Parameters:
bookmarkDisplayName- the display name of the bookmark to set- Throws:
SemanticException
-
showDetailFilter
public boolean showDetailFilter()Gets the flag which indicates whether to show the detail filter or not.- Returns:
- true if the group shows the detail filter, otherwise false.
-
setShowDetailFilter
Sets the flag which indicates whether to show the detail filter or not.- Parameters:
showDetailFilter- the new flag to set- Throws:
SemanticException
-