Interface IGroup
- All Superinterfaces:
IDesignElement
- All Known Subinterfaces:
IListGroup
,ITableGroup
Script wrapper of GroupHandle
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns hide detail.Returns the interval of this group.Return the interval base property value of this group.double
Returns the interval range of this group.Gets the expression that defines the group.getName()
Gets the name of the group.Returns the value for break after property.Returns the value for break before property.Gets the value for break inside property.Returns the sort direction of this group.Return the sort type.Returns the expression evalueated as a table of contents entry for this item.boolean
Checks whether the group footer slot is empty.boolean
Checks whether the group header slot is empty.void
setHideDetail
(boolean hideDetail) Sets hide detail.void
setInterval
(String interval) Returns the interval of this group.void
setIntervalBase
(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
setKeyExpr
(String expr) Sets the group expression.void
Sets the group name.void
setPageBreakAfter
(String value) Sets the value for break after property.void
setPageBreakBefore
(String value) Sets the value for break before property.void
setPageBreakInside
(String value) Sets the value for the page-break-inside.void
setSortDirection
(String direction) Sets the sort direction of this group.void
setSortType
(String sortType) Sets the sort type, which indicates the way of sortingvoid
setTocExpression
(String expression) Sets a table of contents entry for this item.Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
Method Details
-
getKeyExpr
String 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:
-
setKeyExpr
Sets the group expression.- Parameters:
expr
- the expression to set- Throws:
SemanticException
- If the expression is invalid.- See Also:
-
getName
String getName()Gets the name of the group.- Returns:
- the name of the group
-
setName
Sets the group name.- Parameters:
name
- the group name to set- Throws:
SemanticException
- if the name is duplicate or the property is locked.
-
getIntervalBase
String getIntervalBase()Return the interval base property value of this group.- Returns:
- interval baseF 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.
-
getInterval
String getInterval()Returns the interval of this group. The return value is defined inDesignChoiceConstants
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
- Returns:
- the interval value as a string
-
setInterval
Returns the interval of this group. The input value is defined inDesignChoiceConstants
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
- 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
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.
-
getSortDirection
String getSortDirection()Returns the sort direction of this group. The return value is defined inDesignChoiceConstants
and can be one of:SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
- Returns:
- the sort direction of this group
-
setSortDirection
Sets the sort direction of this group. The return value is defined inDesignChoiceConstants
and can be one of:SORT_DIRECTION_ASC
SORT_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
boolean hasHeader()Checks whether the group header slot is empty.- Returns:
- true is the header slot is not empty, otherwise, return false.
-
getTocExpression
String getTocExpression()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:
-
setTocExpression
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:
-
getSortType
String getSortType()Return the sort type.- Returns:
- the sort type.
-
setSortType
Sets the sort type, which indicates the way of sorting- Parameters:
sortType
- sort type.- Throws:
SemanticException
- if the property is locked.
-
getHideDetail
boolean getHideDetail()Returns hide detail.- Returns:
- hide detail.
-
setHideDetail
Sets hide detail.- Parameters:
hideDetail
- hide detail- Throws:
SemanticException
- if the property is locked.
-
getPageBreakBefore
String getPageBreakBefore()Returns the value for break before property. The return value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_BEFORE_AUTO
PAGE_BREAK_BEFORE_ALWAYS
PAGE_BREAK_BEFORE_AVOID
PAGE_BREAK_BEFORE_ALWAYS_EXCLUDING_FIRST
- Returns:
- the value in string
-
setPageBreakBefore
Sets the value for break before property. The input value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_BEFORE_AUTO
PAGE_BREAK_BEFORE_ALWAYS
PAGE_BREAK_BEFORE_AVOID
PAGE_BREAK_BEFORE_ALWAYS_EXCLUDING_FIRST
- Parameters:
value
- the page break before value- Throws:
SemanticException
- if the value is not one of above choices.
-
getPageBreakAfter
String getPageBreakAfter()Returns the value for break after property. The return value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_AFTER_AUTO
PAGE_BREAK_AFTER_ALWAYS
PAGE_BREAK_AFTER_AVOID
PAGE_BREAK_AFTER_ALWAYS_EXCLUDING_LAST
- Returns:
- the value in string
-
setPageBreakAfter
Sets the value for break after property. The return value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_AFTER_AUTO
PAGE_BREAK_AFTER_ALWAYS
PAGE_BREAK_AFTER_AVOID
PAGE_BREAK_AFTER_ALWAYS_EXCLUDING_LAST
- Parameters:
value
- the value to set- Throws:
SemanticException
- if the value is not one of above choices.
-
getPageBreakInside
String getPageBreakInside()Gets the value for break inside property. The return value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_INSIDE_AVOID
PAGE_BREAK_INSIDE_AUTO
- Returns:
- the value in string
-
setPageBreakInside
Sets the value for the page-break-inside. The return value is defined inDesignChoiceConstants
and can be one of:PAGE_BREAK_INSIDE_AVOID
PAGE_BREAK_INSIDE_AUTO
- Parameters:
value
- the value to set- Throws:
SemanticException
- if the value is not one of above choices.
-