|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.GroupHandle
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.
GroupElement
,
SlotHandle
Field Summary |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IGroupElementModel |
BOOKMARK_PROP, BOUND_DATA_COLUMNS_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_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, REPEAT_HEADER_PROP, SLOT_COUNT, SORT_DIRECTION_PROP, SORT_PROP, SORT_TYPE_PROP, TOC_PROP |
Fields 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, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
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. |
Method Summary | |
ComputedColumnHandle |
addColumnBinding(ComputedColumn addColumn,
boolean inForce)
Deprecated. since BIRT 2.1 RC2 |
TOCHandle |
addTOC(java.lang.String expression)
Adds toc structure. |
TOCHandle |
addTOC(TOC toc)
Adds toc structure. |
java.util.Iterator |
columnBindingsIterator()
Deprecated. since BIRT 2.1 RC2 |
java.util.Iterator |
filtersIterator()
Returns an iterator for the filter list defined on the group. |
java.lang.String |
getBookmark()
Returns the bookmark of listing group. |
PropertyHandle |
getColumnBindings()
Deprecated. since BIRT 2.1 RC2 |
SlotHandle |
getFooter()
Returns the footer slot. |
java.lang.String |
getGroupStart()
Deprecated. by getIntervalBase() |
SlotHandle |
getHeader()
Returns the header slot in the group. |
java.lang.String |
getInterval()
Returns the interval of this group. |
java.lang.String |
getIntervalBase()
Return the interval base property value of this group. |
double |
getIntervalRange()
Returns the interval range of this group. |
java.lang.String |
getKeyExpr()
Gets the expression that defines the group. |
java.lang.String |
getName()
Gets the name of the group. |
java.lang.String |
getOnPageBreak()
Gets the on-pageBreak script of the group element. |
java.lang.String |
getOnPrepare()
Gets the on-prepare script of the group. |
java.lang.String |
getPageBreakAfter()
Gets page break after property value of this group. |
java.lang.String |
getPageBreakBefore()
Gets page break before property value of this group. |
java.lang.String |
getPageBreakInside()
Gets page break inside property value of this group. |
java.lang.String |
getSortDirection()
Returns the sort direction of this group. |
java.lang.String |
getSortType()
Return the sort type. |
TOCHandle |
getTOC()
Gets TOC handle. |
java.lang.String |
getTocExpression()
Deprecated. |
boolean |
hasFooter()
Checks whether the group footer slot is empty. |
boolean |
hasHeader()
Checks whether the group header slot is empty. |
boolean |
hideDetail()
Tests whether to hide the detail rows of this group. |
boolean |
repeatHeader()
Tests whether to repeat the headings at the top of each page. |
void |
setBookmark(java.lang.String value)
Sets the bookmark of listing group. |
void |
setGroupStart(java.lang.String groupStart)
Deprecated. by setIntervalBase(String) |
void |
setHideDetail(boolean value)
Sets whether to hide the detail rows of this group. |
void |
setInterval(java.lang.String interval)
Returns the interval of this group. |
void |
setIntervalBase(java.lang.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. |
void |
setIntervalRange(double intervalRange)
Returns the interval range of this group. |
void |
setIntervalRange(java.lang.String intervalRange)
Sets the interval range of group. |
void |
setKeyExpr(java.lang.String expr)
Sets the group expression. |
void |
setName(java.lang.String theName)
Sets the group name. |
void |
setOnPageBreak(java.lang.String script)
Sets the on-pageBreak script of the group element. |
void |
setOnPrepare(java.lang.String script)
Sets the on-prepare script of the group element. |
void |
setPageBreakAfter(java.lang.String value)
Sets page break after property value of this group. |
void |
setPageBreakBefore(java.lang.String value)
Sets page break before property value of this group. |
void |
setPageBreakInside(java.lang.String value)
Sets page break inside property value of this group. |
void |
setRepeatHeader(boolean value)
Sets whether to repeat the headings at the top of each page. |
void |
setSortDirection(java.lang.String direction)
Sets the sort direction of this group. |
void |
setSortType(java.lang.String sortType)
Sets the sort type, which indicates the way of sorting |
void |
setTocExpression(java.lang.String expression)
Deprecated. |
java.util.Iterator |
sortsIterator()
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, setPropertyMask |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public GroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
public SlotHandle getHeader()
public SlotHandle getFooter()
public java.lang.String getKeyExpr()
setKeyExpr(String)
public java.lang.String getName()
getName
in class DesignElementHandle
public void setName(java.lang.String theName) throws NameException
setName
in class DesignElementHandle
theName
- the group name to set
NameException
- if the name is duplicate, or if the name is null
and this element requires a name.public void setKeyExpr(java.lang.String expr) throws SemanticException
expr
- the expression to set
SemanticException
- If the expression is invalid.getKeyExpr()
public java.util.Iterator sortsIterator()
StructureHandle
.
SortKey
structure list defined on
the group.public java.util.Iterator filtersIterator()
StructureHandle
.
FilterCond
structure list defined
on the group.public void setGroupStart(java.lang.String groupStart) throws SemanticException
setIntervalBase(String)
groupStart
- group start property value.
SemanticException
- if the property is locked.public java.lang.String getGroupStart()
getIntervalBase()
public void setIntervalBase(java.lang.String intervalBase) throws SemanticException
intervalBase
- interval base property value.
SemanticException
- if the property is locked.public java.lang.String getIntervalBase()
public java.lang.String getInterval()
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_YEAR
INTERVAL_QUARTER
INTERVAL_MONTH
INTERVAL_WEEK
INTERVAL_DAY
INTERVAL_HOUR
INTERVAL_MINUTE
INTERVAL_SECOND
INTERVAL_INTERVAL
public void setInterval(java.lang.String interval) throws SemanticException
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_YEAR
INTERVAL_QUARTER
INTERVAL_MONTH
INTERVAL_WEEK
INTERVAL_DAY
INTERVAL_HOUR
INTERVAL_MINUTE
INTERVAL_SECOND
INTERVAL_INTERVAL
interval
- the interval value as a string
SemanticException
- if the property is locked or the input value is not one of
the above.public double getIntervalRange()
public void setIntervalRange(double intervalRange) throws SemanticException
intervalRange
- the interval range value as a double
SemanticException
- if the property is locked.public void setIntervalRange(java.lang.String intervalRange) throws SemanticException
intervalRange
- the interval range value as a string.value is locale
dependent.
SemanticException
- if the property is locked.public java.lang.String getSortDirection()
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
public void setSortDirection(java.lang.String direction) throws SemanticException
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
direction
- the sort direction of this group
SemanticException
- if the property is locked or the input value is not one of
the above.public boolean hasHeader()
public boolean hasFooter()
public void setTocExpression(java.lang.String expression) throws SemanticException
expression
- the expression that returns a string
SemanticException
- if the TOC property is locked by the property mask.getTocExpression()
public java.lang.String getTocExpression()
setTocExpression(String)
public void setSortType(java.lang.String sortType) throws SemanticException
sortType
- sort type.
SemanticException
- if the property is locked.public java.lang.String getSortType()
public java.lang.String getOnPrepare()
public void setOnPrepare(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnPrepare()
public boolean repeatHeader()
true
if repeat the headings, otherwise
false
.public void setRepeatHeader(boolean value) throws SemanticException
value
- true
if repeat the headings, otherwise
false
.
SemanticException
- if the property is locked.public java.lang.String getPageBreakAfter()
public void setPageBreakAfter(java.lang.String value) throws SemanticException
value
- value of page break after property
SemanticException
- if the property is locked.public java.lang.String getPageBreakInside()
public void setPageBreakInside(java.lang.String value) throws SemanticException
value
- value of page break inside property
SemanticException
- if the property is locked.public java.lang.String getPageBreakBefore()
public void setPageBreakBefore(java.lang.String value) throws SemanticException
value
- value of page break before property
SemanticException
- if the property is locked.public boolean hideDetail()
true
if hide the detail rows, otherwise
false
.public void setHideDetail(boolean value) throws SemanticException
value
- true
if hide the detail rows, otherwise
false
.
SemanticException
- if the property is locked.public java.lang.String getOnPageBreak()
public void setOnPageBreak(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnPageBreak()
public java.util.Iterator columnBindingsIterator()
ComputedColumnHandle
.
public PropertyHandle getColumnBindings()
public ComputedColumnHandle addColumnBinding(ComputedColumn addColumn, boolean inForce) throws SemanticException
addColumn
- the bound column to addinForce
- true
the column is added to the list regardless
of duplicate expression. false
do not add the
column if the expression already exist
ComputedColumnHandle
or the
existed ComputedColumnHandle
in the list
SemanticException
- if expression is not duplicate but the name duplicates the
exsiting bound column. Or, if the both name/expression are
duplicate, but inForce
is true
.public TOCHandle getTOC()
public TOCHandle addTOC(java.lang.String expression) throws SemanticException
expression
- toc expression
SemanticException
public TOCHandle addTOC(TOC toc) throws SemanticException
toc
- toc structure
SemanticException
public java.lang.String getBookmark()
public void setBookmark(java.lang.String value) throws SemanticException
value
- the property value to be set.
SemanticException
- if the property is locked.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |