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

Class DOCXSettings

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

Document Settings Definition.

Represents the xml file at word/settings.xml.

Author:
Jamson Chan

  • Constructor Summary

    Constructors
    Constructor
    Description
    DOCXSettings(org.apache.poi.xwpf.usermodel.XWPFSettings xwpfSettings, DOCXDocument parent)
    Create a new Document Settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSettings
    getCT()
    Returns the CT object of current element.
    DOCXDocument
    getParent()
    Returns the parent element of current element.
    org.apache.poi.xwpf.usermodel.XWPFSettings
    getXWPF()
    Returns the XWPF object of current element.
    boolean
    isEvenAndOddHeaders()
    Returns whether shows different header and footer of even and odd pages in this document.
    boolean
    isGutterAtTop()
    Returns whether the gutter is at top of this document, if false, the gutter is at left.
    void
    setEvenAndOddHeaders(boolean value)
    Sets whether shows different header and footer of even and odd pages in this document.
    void
    setGutterAtTop(boolean value)
    Sets whether the gutter is at top of this document, if false, the gutter is at left.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DOCXSettings

      public DOCXSettings(org.apache.poi.xwpf.usermodel.XWPFSettings xwpfSettings, DOCXDocument parent)
      Create a new Document Settings.
      Parameters:
      xwpfSettings - the XWPFSettings object.
      parent - the DOCXDocument.

  • Method Details

    • getCT

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

    • getXWPF

      public org.apache.poi.xwpf.usermodel.XWPFSettings getXWPF()
      Description copied from interface: IXWPFElement
      Returns the XWPF object of current element.
      Specified by:
      getXWPF in interface IXWPFElement

    • getParent

      public DOCXDocument getParent()
      Description copied from interface: IXWPFElement
      Returns the parent element of current element.
      Specified by:
      getParent in interface IXWPFElement

    • isEvenAndOddHeaders

      public boolean isEvenAndOddHeaders()
      Returns whether shows different header and footer of even and odd pages in this document.
      Returns:
      whether shows different header and footer of even and odd pages in this document.

    • setEvenAndOddHeaders

      public void setEvenAndOddHeaders(boolean value)
      Sets whether shows different header and footer of even and odd pages in this document.
      Parameters:
      value - whether shows different header and footer of even and odd pages in this document.

    • isGutterAtTop

      public boolean isGutterAtTop()
      Returns whether the gutter is at top of this document, if false, the gutter is at left.
      Returns:
      whether the gutter is at top of this document.

    • setGutterAtTop

      public void setGutterAtTop(boolean value)
      Sets whether the gutter is at top of this document, if false, the gutter is at left.
      Parameters:
      value - whether the gutter is at top of this document.