|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Script wrapper of GroupHandle
Method Summary | |
boolean |
getHideDetail()
Returns hide detail. |
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 |
getSortDirection()
Returns the sort direction of this group. |
java.lang.String |
getSortType()
Return the sort type. |
java.lang.String |
getTocExpression()
Returns the expression evalueated as a table of contents entry for this item. |
boolean |
hasFooter()
Checks whether the group footer slot is empty. |
boolean |
hasHeader()
Checks whether the group header slot is empty. |
void |
setHideDetail(boolean hideDetail)
Sets hide detail |
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 |
setKeyExpr(java.lang.String expr)
Sets the group expression. |
void |
setName(java.lang.String name)
Sets the group name. |
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)
Sets a table of contents entry for this item. |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement |
getNamedExpression, getParent, getQualifiedName, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
public java.lang.String getKeyExpr()
setKeyExpr(String)
public void setKeyExpr(java.lang.String expr) throws SemanticException
expr
- the expression to set
SemanticException
- If the expression is invalid.getKeyExpr()
public java.lang.String getName()
public void setName(java.lang.String name) throws SemanticException
name
- the group name to set
SemanticException
- if the name is duplicate or the property is locked.public java.lang.String 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 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 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 java.lang.String getTocExpression()
setTocExpression(String)
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 getSortType()
public void setSortType(java.lang.String sortType) throws SemanticException
sortType
- sort type.
SemanticException
- if the property is locked.public boolean getHideDetail()
public void setHideDetail(boolean hideDetail) throws SemanticException
hideDetail
- hide detail
SemanticException
- if the property is locked.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |