Class SimpleMasterPageHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IMasterPageModel, org.eclipse.birt.report.model.elements.interfaces.ISimpleMasterPageModel

    public class SimpleMasterPageHandle
    extends MasterPageHandle
    implements org.eclipse.birt.report.model.elements.interfaces.ISimpleMasterPageModel
    Represents a simple master page. The simple master page provides a header and footer that appear on every page.
    • Constructor Detail

      • SimpleMasterPageHandle

        public SimpleMasterPageHandle​(org.eclipse.birt.report.model.core.Module module,
                                      org.eclipse.birt.report.model.core.DesignElement element)
        Constructs the handle for a simple master page with the given design and element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
        Parameters:
        module - the module
        element - the model representation of the element
    • Method Detail

      • showHeaderOnFirst

        public boolean showHeaderOnFirst()
        Tests whether to show the page header on the first page of the report.
        Returns:
        true if allows to show the header on the first page.
      • setShowHeaderOnFirst

        public void setShowHeaderOnFirst​(boolean showHeaderOnFirst)
                                  throws SemanticException
        Changes the status to show page header on the first page or not.
        Parameters:
        showHeaderOnFirst - true if allow show header on the first page, false otherwise.
        Throws:
        SemanticException - if the property is locked.
      • showFooterOnLast

        public boolean showFooterOnLast()
        Tests whether to show the page footer on the last page.
        Returns:
        true if allows to show the footer on the last page.
      • setShowFooterOnLast

        public void setShowFooterOnLast​(boolean showFooterOnLast)
                                 throws SemanticException
        Changes the status to show footer on the last page.
        Parameters:
        showFooterOnLast - true to allow to show footer on last page, false otherwise.
        Throws:
        SemanticException - if the property is locked.
      • isFloatingFooter

        public boolean isFloatingFooter()
        Tests whether allows the footer 'floats' after the last content on each page.
        Returns:
        true if the simple master page allows floating footer.
      • setFloatingFooter

        public void setFloatingFooter​(boolean isFloatingFooter)
                               throws SemanticException
        Changes the status to say if it has a floating footer or not.
        Parameters:
        isFloatingFooter - true to allow the footer floating, false not.
        Throws:
        SemanticException - if the property is locked.
      • getPageHeader

        public SlotHandle getPageHeader()
        Returns the page header slot of this simple master page.
        Returns:
        the page header slot handle.
      • getPageFooter

        public SlotHandle getPageFooter()
        Returns the page footer slot of this simple master page.
        Returns:
        the page footer slot handle.
      • getHeaderHeight

        public DimensionHandle getHeaderHeight()
        Gets a dimension handle to work with the height on page header.
        Returns:
        a DimensionHandle for the header height.
      • getFooterHeight

        public DimensionHandle getFooterHeight()
        Gets a dimension handle to work with the height on page footer.
        Returns:
        a DimensionHandle for the header footer.