Interface IPageContent

All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement, IContainerContent, IContent, IElement, IStyledElement

public interface IPageContent extends IContainerContent
Page instance. The page may contains multiple columns, which is defined in the MasterPage in report design. The content is defined by getBody().
  • 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
    • getFooter

      Collection<IContent> getFooter()
      Get the footer
      Returns:
      the footer
    • getPageHeader

      IContent getPageHeader()
      Get the page header
      Returns:
      the page header
    • getPageFooter

      IContent getPageFooter()
      Get the page footer
      Returns:
      the page footer
    • getPageBody

      IContent getPageBody()
      Get the page body
      Returns:
      the page body
    • setPageHeader

      void setPageHeader(IContent header)
      Set the page header
      Parameters:
      header - header content
    • setPageFooter

      void setPageFooter(IContent footer)
      Set the page footer
      Parameters:
      footer - footer content
    • setPageBody

      void setPageBody(IContent body)
      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
    • getFooterHeight

      org.eclipse.birt.report.engine.ir.DimensionType getFooterHeight()
      Get the footer height
      Returns:
      the footer 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 IStyle 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 IStyle getContentComputedStyle()
      Deprecated.
      use getPageBody().getComputedStyle()
      Get the computed style of content
      Returns:
      computed style of content