org.apache.poi.xwpf.usermodel

Class XWPFNumbering

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xwpf.usermodel.XWPFNumbering

public class XWPFNumbering
extends POIXMLDocumentPart

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

POIXMLDocumentPart.RelationPart

Field Summary

Fields

Modifier and Type	Field and Description
protected List<XWPFAbstractNum>	abstractNums
protected List<XWPFNum>	nums

Constructor Summary

Constructors

Constructor and Description
XWPFNumbering() create a new XWPFNumbering object for use in a new document
XWPFNumbering(PackagePart part) create a new styles object with an existing document

Method Summary

Modifier and Type	Method and Description
BigInteger	addAbstractNum(XWPFAbstractNum abstractNum) add a new AbstractNum and return its AbstractNumID
BigInteger	addNum(BigInteger abstractNumID) Add a new num with an abstractNumID
void	addNum(BigInteger abstractNumID, BigInteger numID) Add a new num with an abstractNumID and a numID
BigInteger	addNum(XWPFNum num) add a new number to the numbering document
protected void	commit() save and commit numbering
XWPFAbstractNum	getAbstractNum(BigInteger abstractNumID) get AbstractNum by abstractNumID
BigInteger	getAbstractNumID(BigInteger numID) return the abstractNumID If the AbstractNumID not exists return null
List<XWPFAbstractNum>	getAbstractNums()
BigInteger	getIdOfAbstractNum(XWPFAbstractNum abstractNum) Compare AbstractNum with abstractNums of this numbering document.
XWPFNum	getNum(BigInteger numID) get Num by NumID
List<XWPFNum>	getNums()
boolean	numExist(BigInteger numID) Checks whether number with numID exists
protected void	onDocumentRead() read numbering form an existing package
boolean	removeAbstractNum(BigInteger abstractNumID) remove an existing abstractNum
void	setNumbering(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNumbering numbering) Sets the ctNumbering

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createHyperlink, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getReferenceRelationship, getReferenceRelationships, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeReferenceRelationship, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

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

Field Detail

abstractNums

protected List<XWPFAbstractNum> abstractNums

nums

protected List<XWPFNum> nums

Constructor Detail

XWPFNumbering

public XWPFNumbering(PackagePart part)

create a new styles object with an existing document

Since:

POI 3.14-Beta1

XWPFNumbering

public XWPFNumbering()

create a new XWPFNumbering object for use in a new document

Method Detail

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

numExist

public boolean numExist(BigInteger numID)

Checks whether number with numID exists

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

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

getNum

public XWPFNum getNum(BigInteger numID)

get Num by 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

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

Returns:

BigInteger

addAbstractNum

public BigInteger addAbstractNum(XWPFAbstractNum abstractNum)

add a new AbstractNum and return its AbstractNumID

removeAbstractNum

public boolean removeAbstractNum(BigInteger abstractNumID)

remove an existing abstractNum

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

Returns:

abstractNumID

getAbstractNums

public List<XWPFAbstractNum> getAbstractNums()

Returns:

all abstractNums

getNums

public List<XWPFNum> getNums()

Returns:

all nums