Package io.keikai.doc.io.schema.docx

Class DOCXSectPr

java.lang.Object
io.keikai.doc.io.schema.docx.DOCXSectPr
All Implemented Interfaces:
ICTElement
public class DOCXSectPr extends Object implements ICTElement
Internal Use Only.

Section Properties Definition.

Represents w:sectPr in xml.

Author:
Jamson Chan

  • Constructor Details

    • DOCXSectPr

      public DOCXSectPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr sectPr)
      Create a new SectPr by given CTSectPr.
      Parameters:
      sectPr - the CTSectPr object.

  • Method Details

    • getCT

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr getCT()
      Description copied from interface: ICTElement
      Returns the CT object of current element.
      Specified by:
      getCT in interface ICTElement

    • addBodyElements

      public void addBodyElements(List<AbstractBodyElement> elements)
      Adds the body elements to this section.
      Parameters:
      elements -

    • getBodyElements

      public List<AbstractBodyElement> getBodyElements()
      Returns the body elements.
      Returns:
      the body elements.

    • getPageWidth

      public Double getPageWidth()
      Returns the page width.
      Returns:
      the page width.

    • setPageWidth

      public void setPageWidth(Double width)
      Sets the page width.
      Parameters:
      width - the page width.

    • getPageHeight

      public Double getPageHeight()
      Returns the page height.
      Returns:
      the page height.

    • setPageHeight

      public void setPageHeight(Double height)
      Sets the page height.
      Parameters:
      height - the page height.

    • getMarginTop

      public Double getMarginTop()
      Returns the page top margin.
      Returns:
      the page top margin.

    • setMarginTop

      public void setMarginTop(Double top)
      Sets the page top margin.
      Parameters:
      top - the page top margin.

    • getMarginLeft

      public Double getMarginLeft()
      Returns the page left margin.
      Returns:
      the page left margin.

    • setMarginLeft

      public void setMarginLeft(Double left)
      Sets the page left margin.
      Parameters:
      left - the page left margin.

    • getMarginBottom

      public Double getMarginBottom()
      Returns the page bottom margin.
      Returns:
      the page bottom margin.

    • setMarginBottom

      public void setMarginBottom(Double bottom)
      Sets the page bottom margin.
      Parameters:
      bottom - the page bottom margin.

    • getMarginRight

      public Double getMarginRight()
      Returns the page right margin.
      Returns:
      the page right margin.

    • setMarginRight

      public void setMarginRight(Double right)
      Sets the page right margin.
      Parameters:
      right - the page right margin.

    • getHeaderFromTop

      public Double getHeaderFromTop()
      Returns the distance of header from top edge.
      Returns:
      the distance of header from top edge.

    • setHeaderFromTop

      public void setHeaderFromTop(Double headerFromTop)
      Sets the distance of header from top edge.
      Parameters:
      headerFromTop - the distance of header from top edge.

    • getFooterFromBottom

      public Double getFooterFromBottom()
      Returns the distance of footer from bottom edge.
      Returns:
      the distance of footer from bottom edge.

    • setFooterFromBottom

      public void setFooterFromBottom(Double footerFromBottom)
      Sets the distance of footer from bottom edge.
      Parameters:
      footerFromBottom - the distance of footer from bottom edge.

    • getGutter

      public Double getGutter()
      Returns the gutter margin.
      Returns:
      the gutter margin.

    • setGutter

      public void setGutter(Double gutter)
      Sets the gutter margin.
      Parameters:
      gutter - the gutter margin.

    • 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.

    • getType

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STSectionMark.Enum getType()
      Returns the type of section start.
      Returns:
      the type of section start.

    • setType

      public void setType(org.openxmlformats.schemas.wordprocessingml.x2006.main.STSectionMark.Enum type)
      Sets the type of section start.
      Parameters:
      type - the type of section start.

    • getFirstHeaderId

      public String getFirstHeaderId()
      Returns the header id of first page.
      Returns:
      the header id of first page.

    • getDefaultHeaderId

      public String getDefaultHeaderId()
      Returns the header id of default page.
      Returns:
      the header id of default page.

    • getEvenHeaderId

      public String getEvenHeaderId()
      Returns the header id of even page.
      Returns:
      the header id of even page.

    • getFirstFooterId

      public String getFirstFooterId()
      Returns the footer id of first page.
      Returns:
      the footer id of first page.

    • getDefaultFooterId

      public String getDefaultFooterId()
      Returns the footer id of default page.
      Returns:
      the footer id of default page.

    • getEvenFooterId

      public String getEvenFooterId()
      Returns the footer id of even page.
      Returns:
      the footer id of even page.