Package io.keikai.doc.io.schema.pdf

Class PDFSection

  • All Implemented Interfaces:
    IPDFElement
    public class PDFSection
extends PDFContainer
    Internal Use Only.

    Represents a section in a PDF document.

    Author:
    Jamson Chan

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFSection()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PDFHeaderFooter getFooter​(io.keikai.doc.api.impl.node.PageType pageType)
      Returns the footer of the specified page type.
      PDFHeaderFooter getHeader​(io.keikai.doc.api.impl.node.PageType pageType)
      Returns the header of the specified page type.
      float getMarginBottom()
      Returns the bottom margin of the page.
      float getMarginLeft()  
      float getMarginRight()
      Returns the right margin of the page.
      float getMarginTop()
      Returns the top margin of the page.
      float getPageHeight()
      Returns the height of the page.
      float getPageWidth()
      Returns the width of the page.
      boolean isTitlePg()
      Returns whether to use different first header and footer.
      void setFooter​(PDFHeaderFooter footer, io.keikai.doc.api.impl.node.PageType pageType)
      Sets the footer of the specified page type.
      void setHeader​(PDFHeaderFooter header, io.keikai.doc.api.impl.node.PageType pageType)
      Sets the header of the specified page type.
      void setMarginBottom​(float marginBottom)
      Sets the bottom margin of the page.
      void setMarginLeft​(float marginLeft)
      Sets the left margin of the page.
      void setMarginRight​(float marginRight)
      Sets the right margin of the page.
      void setMarginTop​(float marginTop)
      Sets the top margin of the page.
      void setPageHeight​(float pageHeight)
      Sets the height of the page.
      void setPageWidth​(float pageWidth)
      Sets the width of the page.
      void setTitlePg​(boolean titlePg)
      Sets whether to use different first header and footer.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PDFSection

        public PDFSection()

    • Method Detail

      • getHeader

        public PDFHeaderFooter getHeader​(io.keikai.doc.api.impl.node.PageType pageType)
        Returns the header of the specified page type.
        Parameters:
        pageType - the page type.
        Returns:
        the header of the specified page type.

      • setHeader

        public void setHeader​(PDFHeaderFooter header,
                      io.keikai.doc.api.impl.node.PageType pageType)
        Sets the header of the specified page type.
        Parameters:
        header - the header to set.
        pageType - the page type.

      • getFooter

        public PDFHeaderFooter getFooter​(io.keikai.doc.api.impl.node.PageType pageType)
        Returns the footer of the specified page type.
        Parameters:
        pageType - the page type.
        Returns:
        the footer of the specified page type.

      • setFooter

        public void setFooter​(PDFHeaderFooter footer,
                      io.keikai.doc.api.impl.node.PageType pageType)
        Sets the footer of the specified page type.
        Parameters:
        footer - the footer to set.
        pageType - the page type.

      • getPageWidth

        public float getPageWidth()
        Returns the width of the page.
        Returns:
        the width of the page.

      • setPageWidth

        public void setPageWidth​(float pageWidth)
        Sets the width of the page.
        Parameters:
        pageWidth - the width of the page.

      • getPageHeight

        public float getPageHeight()
        Returns the height of the page.
        Returns:
        the height of the page.

      • setPageHeight

        public void setPageHeight​(float pageHeight)
        Sets the height of the page.
        Parameters:
        pageHeight - the height of the page.

      • getMarginTop

        public float getMarginTop()
        Returns the top margin of the page.
        Returns:
        the top margin of the page.

      • setMarginTop

        public void setMarginTop​(float marginTop)
        Sets the top margin of the page.
        Parameters:
        marginTop - the top margin of the page.

      • getMarginRight

        public float getMarginRight()
        Returns the right margin of the page.
        Returns:
        the right margin of the page.

      • setMarginRight

        public void setMarginRight​(float marginRight)
        Sets the right margin of the page.
        Parameters:
        marginRight - the right margin of the page.

      • getMarginBottom

        public float getMarginBottom()
        Returns the bottom margin of the page.
        Returns:
        the bottom margin of the page.

      • setMarginBottom

        public void setMarginBottom​(float marginBottom)
        Sets the bottom margin of the page.
        Parameters:
        marginBottom - the bottom margin of the page.

      • getMarginLeft

        public float getMarginLeft()

      • setMarginLeft

        public void setMarginLeft​(float marginLeft)
        Sets the left margin of the page.
        Parameters:
        marginLeft - the left margin of the page.

      • isTitlePg

        public boolean isTitlePg()
        Returns whether to use different first header and footer.
        Returns:
        whether to use different first header and footer.

      • setTitlePg

        public void setTitlePg​(boolean titlePg)
        Sets whether to use different first header and footer.
        Parameters:
        titlePg - whether to use different first header and footer.