Interface IPageContent
- All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement
,IContainerContent
,IContent
,IElement
,IStyledElement
Page instance.
The page may contains multiple columns, which is defined in the MasterPage in
report design.
The content is defined by getBody().
-
Field Summary
Fields 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 TypeMethodDescriptionDeprecated.use getPageBody().getComputedStyle()Deprecated.use getPageBody().getStyle()Get the footerorg.eclipse.birt.report.engine.ir.DimensionType
Get the footer heightGet the headerorg.eclipse.birt.report.engine.ir.DimensionType
Get the header heightorg.eclipse.birt.report.engine.ir.DimensionType
Get the width of the left partorg.eclipse.birt.report.engine.ir.DimensionType
Get the margin bottomorg.eclipse.birt.report.engine.ir.DimensionType
Get the margin leftorg.eclipse.birt.report.engine.ir.DimensionType
Get the margin rightorg.eclipse.birt.report.engine.ir.DimensionType
Get the margin topGet the orientationGet the page bodyGet the page footerGet the page headerorg.eclipse.birt.report.engine.ir.DimensionType
Get the page heightlong
Get the page numberGet the page typeorg.eclipse.birt.report.engine.ir.DimensionType
Get the page widthorg.eclipse.birt.report.engine.ir.DimensionType
Get the width of the right partGet the watermarkvoid
setPageBody
(IContent body) Set the pagebodyvoid
setPageFooter
(IContent footer) Set the page footervoid
setPageHeader
(IContent header) Set the page headervoid
setPageNumber
(long pageNumber) Set page numberMethods 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, getTagType, 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, setTagType, 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
-
Method Details
-
getOrientation
String getOrientation()Get the orientation- Returns:
- the orientation
-
getPageType
String getPageType()Get the page type- Returns:
- the page type
-
getPageHeight
org.eclipse.birt.report.engine.ir.DimensionType getPageHeight()Get the page height- Returns:
- the page height
-
getPageWidth
org.eclipse.birt.report.engine.ir.DimensionType getPageWidth()Get the page width- Returns:
- the page width
-
getWaterMark
IImageContent getWaterMark()Get the watermark- Returns:
- the watermark
-
getHeader
Collection<IContent> getHeader()Get the header- Returns:
- the header
-
getPageHeader
IContent getPageHeader()Get the page header- Returns:
- the page header
-
getPageBody
IContent getPageBody()Get the page body- Returns:
- the page body
-
setPageHeader
Set the page header- Parameters:
header
- header content
-
setPageBody
Set the pagebody- Parameters:
body
- body content
-
getMarginTop
org.eclipse.birt.report.engine.ir.DimensionType getMarginTop()Get the margin top- Returns:
- the margin top
-
getMarginBottom
org.eclipse.birt.report.engine.ir.DimensionType getMarginBottom()Get the margin bottom- Returns:
- the margin bottom
-
getMarginLeft
org.eclipse.birt.report.engine.ir.DimensionType getMarginLeft()Get the margin left- Returns:
- the margin left
-
getMarginRight
org.eclipse.birt.report.engine.ir.DimensionType getMarginRight()Get the margin right- Returns:
- the margin right
-
getHeaderHeight
org.eclipse.birt.report.engine.ir.DimensionType getHeaderHeight()Get the header height- Returns:
- the header height
-
getLeftWidth
org.eclipse.birt.report.engine.ir.DimensionType getLeftWidth()Get the width of the left part- Returns:
- the width of the left part
-
getRightWidth
org.eclipse.birt.report.engine.ir.DimensionType getRightWidth()Get the width of the right part- Returns:
- the width of the right part
-
getContentStyle
Deprecated.use getPageBody().getStyle()Get the content style- Returns:
- the content style
-
getPageNumber
long getPageNumber()Get the page number- Returns:
- page number
-
setPageNumber
void setPageNumber(long pageNumber) Set page number- Parameters:
pageNumber
- page number
-
getContentComputedStyle
Deprecated.use getPageBody().getComputedStyle()Get the computed style of content- Returns:
- computed style of content
-