Interface IBandContent
- All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement
,IContainerContent
,IContent
,IElement
,IStyledElement
- All Known Subinterfaces:
IListBandContent
,ITableBandContent
Provides the interface for the Band Content. All types of bands for table,
group, list, such as table-header/detail/footer, group-header/detail/footer,
list-header/detail/footer, are implemented as instances of this class.
The following types for the band content are predefined:
BAND_HEADER
BAND_FOOTER
GROUP_HEADER
GROUP_FOOTER
BAND_DETAIL
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
property: band detailstatic final int
property: band footerstatic final int
property: band group footerstatic final int
property: band group headerstatic final int
property: band headerFields inherited from interface org.eclipse.birt.report.engine.content.IContent
AUTOTEXT_CONTENT, CELL_CONTENT, CONTAINER_CONTENT, DATA_CONTENT, DOCUMENT_EXTENSION, FOREIGN_CONTENT, GROUP_CONTENT, IMAGE_CONTENT, LABEL_CONTENT, LAYOUT_EXTENSION, LIST_BAND_CONTENT, LIST_CONTENT, LIST_GROUP_CONTENT, PAGE_CONTENT, REPORT_CONTENT, ROW_CONTENT, SERIALIZE_CONTENT, TABLE_BAND_CONTENT, TABLE_CONTENT, TABLE_GROUP_CONTENT, TEXT_CONTENT
-
Method Summary
Modifier and TypeMethodDescriptionint
Get the type of the band content.Get the group id if the band content is in some group.void
setBandType
(int bandType) Set the type of the band content.Methods inherited from interface org.eclipse.birt.report.engine.css.engine.CSSStylableElement
getComputedStyle, getCSSEngine, getStyle
Methods inherited from interface org.eclipse.birt.report.engine.content.IContent
accept, cloneContent, getACL, getAltText, getAltTextKey, getBookmark, getContentType, getExtension, getExtensions, getGenerateBy, getHeight, getHelpText, getHyperlinkAction, getInlineStyle, getInstanceID, getName, getReportContent, getResultSet, getTOC, getUserProperties, getWidth, getX, getY, hasChildren, isDirectionRTL, isLastChild, isRTL, readContent, setACL, setAltText, setAltTextKey, setBookmark, setExtension, setExtensions, setGenerateBy, setHasChildren, setHeight, setHelpText, setHyperlinkAction, setInlineStyle, setInstanceID, setLastChild, setName, setReportContent, setTOC, setUserProperties, setWidth, setX, setY, writeContent
Methods inherited from interface org.eclipse.birt.report.engine.content.IElement
getChildren, getParent, setParent
Methods inherited from interface org.eclipse.birt.report.engine.content.IStyledElement
getComputedStyle, getStyle, getStyleClass, setStyleClass
-
Field Details
-
BAND_HEADER
static final int BAND_HEADERproperty: band header- See Also:
-
BAND_FOOTER
static final int BAND_FOOTERproperty: band footer- See Also:
-
BAND_GROUP_HEADER
static final int BAND_GROUP_HEADERproperty: band group header- See Also:
-
BAND_GROUP_FOOTER
static final int BAND_GROUP_FOOTERproperty: band group footer- See Also:
-
BAND_DETAIL
static final int BAND_DETAILproperty: band detail- See Also:
-
-
Method Details
-
getBandType
int getBandType()Get the type of the band content. The return result of this method is inint
format, and theint
value must be one of the following predefined values in classIBandContent
:BAND_HEADER
BAND_FOOTER
GROUP_HEADER
GROUP_FOOTER
BAND_DETAIL
- Returns:
- type of the band content.
-
setBandType
void setBandType(int bandType) Set the type of the band content. The value of parameterbandType
must be one of the following predefined values in classIBandContent
:BAND_HEADER
BAND_FOOTER
GROUP_HEADER
GROUP_FOOTER
BAND_DETAIL
- Parameters:
bandType
- the type of the band content.
-
getGroupID
String getGroupID()Get the group id if the band content is in some group. This method will returnnull
when the band content is not a group header and group footer.- Returns:
- the group id.
-