org.eclipse.birt.report.model.api.simpleapi
Interface IGroup

All Superinterfaces:
IDesignElement
All Known Subinterfaces:
IListGroup, ITableGroup

public interface IGroup
extends IDesignElement

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.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty
 

Method Detail

getKeyExpr

java.lang.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(String)

setKeyExpr

void setKeyExpr(java.lang.String expr)
                throws SemanticException
Sets the group expression.

Parameters:
expr - the expression to set
Throws:
SemanticException - If the expression is invalid.
See Also:
getKeyExpr()

getName

java.lang.String getName()
Gets the name of the group.

Returns:
the name of the group

setName

void setName(java.lang.String name)
             throws SemanticException
Sets the group name.

Parameters:
name - the group name to set
Throws:
SemanticException - if the name is duplicate or the property is locked.

getIntervalBase

java.lang.String getIntervalBase()
Return the interval base property value of this group.

Returns:
interval baseF property value of this group.

setIntervalBase

void setIntervalBase(java.lang.String intervalBase)
                     throws SemanticException
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

java.lang.String getInterval()
Returns the interval of this group. The return value is defined in DesignChoiceConstants and can be one of:

Returns:
the interval value as a string

setInterval

void setInterval(java.lang.String interval)
                 throws SemanticException
Returns the interval of this group. The input value is defined in DesignChoiceConstants and can be one of:

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

void setIntervalRange(double intervalRange)
                      throws SemanticException
Returns the interval range of this group.

Parameters:
intervalRange - the interval range value as a double
Throws:
SemanticException - if the property is locked.

getSortDirection

java.lang.String getSortDirection()
Returns the sort direction of this group. The return value is defined in DesignChoiceConstants and can be one of:

Returns:
the sort direction of this group

setSortDirection

void setSortDirection(java.lang.String direction)
                      throws SemanticException
Sets the sort direction of this group. The return value is defined in DesignChoiceConstants and can be one of:

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.

hasFooter

boolean hasFooter()
Checks whether the group footer slot is empty.

Returns:
true is the footer slot is not empty, otherwise, return false.

getTocExpression

java.lang.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(String)

setTocExpression

void setTocExpression(java.lang.String expression)
                      throws SemanticException
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()

getSortType

java.lang.String getSortType()
Return the sort type.

Returns:
the sort type.

setSortType

void setSortType(java.lang.String sortType)
                 throws SemanticException
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

void setHideDetail(boolean hideDetail)
                   throws SemanticException
Sets hide detail.

Parameters:
hideDetail - hide detail
Throws:
SemanticException - if the property is locked.

getPageBreakBefore

java.lang.String getPageBreakBefore()
Returns the value for break before property. The return value is defined in DesignChoiceConstants and can be one of:

Returns:
the value in string

setPageBreakBefore

void setPageBreakBefore(java.lang.String value)
                        throws SemanticException
Sets the value for break before property. The input value is defined in DesignChoiceConstants and can be one of:

Parameters:
value - the page break before value
Throws:
SemanticException - if the value is not one of above choices.

getPageBreakAfter

java.lang.String getPageBreakAfter()
Returns the value for break after property. The return value is defined in DesignChoiceConstants and can be one of:

Returns:
the value in string

setPageBreakAfter

void setPageBreakAfter(java.lang.String value)
                       throws SemanticException
Sets the value for break after property. The return value is defined in DesignChoiceConstants and can be one of:

Parameters:
value - the value to set
Throws:
SemanticException - if the value is not one of above choices.

getPageBreakInside

java.lang.String getPageBreakInside()
Gets the value for break inside property. The return value is defined in DesignChoiceConstants and can be one of:

Returns:
the value in string

setPageBreakInside

void setPageBreakInside(java.lang.String value)
                        throws SemanticException
Sets the value for the page-break-inside. The return value is defined in DesignChoiceConstants and can be one of:

Parameters:
value - the value to set
Throws:
SemanticException - if the value is not one of above choices.


Copyright © 2008 Actuate Corp. All rights reserved.