Class XWPFNumbering

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xwpf.usermodel.XWPFNumbering

public class XWPFNumbering extends POIXMLDocumentPart
Author:
Philipp Epp
  • Field Details

  • Constructor Details

  • Method Details

    • onDocumentRead

      protected void onDocumentRead() throws IOException
      read numbering form an existing package
      Overrides:
      onDocumentRead in class POIXMLDocumentPart
      Throws:
      IOException - a subclass may throw an IOException when a document is read
    • commit

      protected void commit() throws IOException
      save and commit numbering
      Overrides:
      commit in class POIXMLDocumentPart
      Throws:
      IOException - a subclass may throw an IOException if the changes can't be committed
    • setNumbering

      public void setNumbering(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumbering numbering)
      Sets the ctNumbering
      Parameters:
      numbering -
    • numExist

      public boolean numExist(BigInteger numID)
      Checks whether number with numID exists
      Parameters:
      numID -
      Returns:
      boolean true if num exist, false if num not exist
    • addNum

      public BigInteger addNum(XWPFNum num)
      add a new number to the numbering document
      Parameters:
      num -
    • addNum

      public BigInteger addNum(BigInteger abstractNumID)
      Add a new num with an abstractNumID
      Returns:
      return NumId of the added num
    • addNum

      public void addNum(BigInteger abstractNumID, BigInteger numID)
      Add a new num with an abstractNumID and a numID
      Parameters:
      abstractNumID -
      numID -
    • getNum

      public XWPFNum getNum(BigInteger numID)
      get Num by NumID
      Parameters:
      numID -
      Returns:
      abstractNum with NumId if no Num exists with that NumID null will be returned
    • getAbstractNum

      public XWPFAbstractNum getAbstractNum(BigInteger abstractNumID)
      get AbstractNum by abstractNumID
      Parameters:
      abstractNumID -
      Returns:
      abstractNum with abstractNumId if no abstractNum exists with that abstractNumID null will be returned
    • getIdOfAbstractNum

      public BigInteger getIdOfAbstractNum(XWPFAbstractNum abstractNum)
      Compare AbstractNum with abstractNums of this numbering document. If the content of abstractNum equals with an abstractNum of the List in numbering the BigInteger Value of it will be returned. If no equal abstractNum is existing null will be returned
      Parameters:
      abstractNum -
      Returns:
      BigInteger
    • addAbstractNum

      public BigInteger addAbstractNum(XWPFAbstractNum abstractNum)
      add a new AbstractNum and return its AbstractNumID
      Parameters:
      abstractNum -
    • removeAbstractNum

      public boolean removeAbstractNum(BigInteger abstractNumID)
      remove an existing abstractNum
      Parameters:
      abstractNumID -
      Returns:
      true if abstractNum with abstractNumID exists in NumberingArray, false if abstractNum with abstractNumID not exists
    • getAbstractNumID

      public BigInteger getAbstractNumID(BigInteger numID)
      return the abstractNumID If the AbstractNumID not exists return null
      Parameters:
      numID -
      Returns:
      abstractNumID