|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGroup
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 |
getPageBreakAfter()
Returns the value for break after property. |
java.lang.String |
getPageBreakBefore()
Returns the value for break before property. |
java.lang.String |
getPageBreakInside()
Gets the value for break inside property. |
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 |
setPageBreakAfter(java.lang.String value)
Sets the value for break after property. |
void |
setPageBreakBefore(java.lang.String value)
Sets the value for break before property. |
void |
setPageBreakInside(java.lang.String value)
Sets the value for the page-break-inside. |
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.engine.api.script.element.IDesignElement |
---|
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
java.lang.String getKeyExpr()
setKeyExpr(String)
void setKeyExpr(java.lang.String expr) throws ScriptException
expr
- the expression to set
ScriptException
- If the expression is invalid.getKeyExpr()
java.lang.String getName()
void setName(java.lang.String name) throws ScriptException
name
- the group name to set
ScriptException
- if the name is duplicate or the property is locked.java.lang.String getIntervalBase()
void setIntervalBase(java.lang.String intervalBase) throws ScriptException
intervalBase
- interval base property value.
ScriptException
- if the property is locked.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
void setInterval(java.lang.String interval) throws ScriptException
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
ScriptException
- if the property is locked or the input value is not one of
the above.double getIntervalRange()
void setIntervalRange(double intervalRange) throws ScriptException
intervalRange
- the interval range value as a double
ScriptException
- if the property is locked.java.lang.String getSortDirection()
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
void setSortDirection(java.lang.String direction) throws ScriptException
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
direction
- the sort direction of this group
ScriptException
- if the property is locked or the input value is not one of
the above.boolean hasHeader()
boolean hasFooter()
java.lang.String getTocExpression()
setTocExpression(String)
void setTocExpression(java.lang.String expression) throws ScriptException
expression
- the expression that returns a string
ScriptException
- if the TOC property is locked by the property mask.getTocExpression()
java.lang.String getSortType()
void setSortType(java.lang.String sortType) throws ScriptException
sortType
- sort type.
ScriptException
- if the property is locked.boolean getHideDetail()
void setHideDetail(boolean hideDetail) throws ScriptException
hideDetail
- hide detail
ScriptException
- if the property is locked.java.lang.String getPageBreakBefore()
DesignChoiceConstants
and can be one of:
PAGE_BREAK_BEFORE_AUTO
PAGE_BREAK_BEFORE_ALWAYS
PAGE_BREAK_BEFORE_AVOID
PAGE_BREAK_BEFORE_ALWAYS_EXCLUDING_FIRST
void setPageBreakBefore(java.lang.String value) throws ScriptException
DesignChoiceConstants
and can be one of:
PAGE_BREAK_BEFORE_AUTO
PAGE_BREAK_BEFORE_ALWAYS
PAGE_BREAK_BEFORE_AVOID
PAGE_BREAK_BEFORE_ALWAYS_EXCLUDING_FIRST
value
- the page break before value
ScriptException
- if the value is not one of above choices.java.lang.String getPageBreakAfter()
DesignChoiceConstants
and can be one of:
PAGE_BREAK_AFTER_AUTO
PAGE_BREAK_AFTER_ALWAYS
PAGE_BREAK_AFTER_AVOID
PAGE_BREAK_AFTER_ALWAYS_EXCLUDING_LAST
void setPageBreakAfter(java.lang.String value) throws ScriptException
DesignChoiceConstants
and can be one of:
PAGE_BREAK_AFTER_AUTO
PAGE_BREAK_AFTER_ALWAYS
PAGE_BREAK_AFTER_AVOID
PAGE_BREAK_AFTER_ALWAYS_EXCLUDING_LAST
value
- the value to set
ScriptException
- if the value is not one of above choices.java.lang.String getPageBreakInside()
DesignChoiceConstants
and can be one of:
PAGE_BREAK_INSIDE_AVOID
PAGE_BREAK_INSIDE_AUTO
void setPageBreakInside(java.lang.String value) throws ScriptException
DesignChoiceConstants
and can be one of:
PAGE_BREAK_INSIDE_AVOID
PAGE_BREAK_INSIDE_AUTO
value
- the value to set
ScriptException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |