Package org.docx4j.openpackaging.parts.WordprocessingML

Class NumberingDefinitionsPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<E>

org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware<Numbering>

org.docx4j.openpackaging.parts.WordprocessingML.NumberingDefinitionsPart

All Implemented Interfaces:

XPathEnabled<Numbering>

public final class NumberingDefinitionsPart
extends JaxbXmlPartXPathAware<Numbering>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) HashMap<String,AbstractListNumberingDefinition>	abstractListDefinitions
private Emulator	em
(package private) HashMap<String,ListNumberingDefinition>	instanceListDefinitions
private static org.slf4j.Logger	log
private boolean	numStyleLinkIsPresent

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

binder

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
NumberingDefinitionsPart()
NumberingDefinitionsPart(PartName partName)

Method Summary

Modifier and Type	Method	Description
Numbering.Num	addAbstractListNumberingDefinition(Numbering.AbstractNum abstractNum)	Add the specified definition, allocating it a new w:abstractNumId.
void	addAbstractListNumberingDefinitionLevel(Numbering.AbstractNum abstractNum, Lvl lvl)
HashMap<String,AbstractListNumberingDefinition>	getAbstractListDefinitions()
Emulator	getEmulator()
Emulator	getEmulator(boolean reset)
PPrBase.Ind	getInd(String numId, String ilvl)
PPrBase.Ind	getInd(PPrBase.NumPr numPr)
private PPrBase.Ind	getIndFromLvl(Lvl lvl)
HashMap<String,ListNumberingDefinition>	getInstanceListDefinitions()
String	getMceIgnorable()
private StyleDefinitionsPart	getStyleDefinitionsPart()
void	init()
void	initialiseMaps()
void	initialiseMaps(boolean resolveNumStyleLink)
private void	resolveLinkedAbstractNum()
void	resolveLinkedAbstractNum(Numbering.AbstractNum abstractNum, AbstractListNumberingDefinition absNumDef)
long	restart(long numId, long ilvl, long val)	For the given *concrete* list numId, restart the numbering on the specified level at value val.
private long	restart(Numbering.Num num, long ilvl, long val)
protected void	setMceIgnorable(McIgnorableNamespaceDeclarator namespacePrefixMapper)	Where the mc:Ignorable attribute is present, ensure its contents matches the ignorable namespaces actually present.
Numbering	unmarshalDefaultNumbering()

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

createBinderAndJaxbElement, getBinder, getJAXBAssociationsForXPath, getJAXBAssociationsForXPath, getJAXBNodesViaXPath, getJAXBNodesViaXPath, setJaxbElement, unmarshal, unmarshal

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getXML, getXMLStreamReader, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, replacePartContent, setContents, setJAXBContext, setJaxbElement, transform, transformToDom, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Field Details

log

private static org.slf4j.Logger log

abstractListDefinitions

HashMap<String,AbstractListNumberingDefinition> abstractListDefinitions

instanceListDefinitions

HashMap<String,ListNumberingDefinition> instanceListDefinitions

numStyleLinkIsPresent

private boolean numStyleLinkIsPresent

em

private Emulator em

Constructor Details

NumberingDefinitionsPart

public NumberingDefinitionsPart(PartName partName)
                         throws InvalidFormatException

Throws:

InvalidFormatException

NumberingDefinitionsPart

public NumberingDefinitionsPart()
                         throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

init

public void init()

setMceIgnorable

protected void setMceIgnorable(McIgnorableNamespaceDeclarator namespacePrefixMapper)

Description copied from class: JaxbXmlPart

Where the mc:Ignorable attribute is present, ensure its contents matches the ignorable namespaces actually present.

Overrides:

setMceIgnorable in class JaxbXmlPart<Numbering>

getMceIgnorable

public String getMceIgnorable()

Overrides:

getMceIgnorable in class JaxbXmlPart<Numbering>

getAbstractListDefinitions

public HashMap<String,AbstractListNumberingDefinition> getAbstractListDefinitions()

getInstanceListDefinitions

public HashMap<String,ListNumberingDefinition> getInstanceListDefinitions()

getStyleDefinitionsPart

private StyleDefinitionsPart getStyleDefinitionsPart()

initialiseMaps

public void initialiseMaps()

initialiseMaps

public void initialiseMaps(boolean resolveNumStyleLink)

resolveLinkedAbstractNum

private void resolveLinkedAbstractNum()

resolveLinkedAbstractNum

public void resolveLinkedAbstractNum(Numbering.AbstractNum abstractNum,
 AbstractListNumberingDefinition absNumDef)

restart

public long restart(long numId,
 long ilvl,
 long val)
             throws InvalidOperationException

For the given *concrete* list numId, restart the numbering on the specified level at value val. This is done by creating a new list (ie <w:num>) which uses the existing w:abstractNum.

Parameters:

numId -

ilvl -

val -

Returns:

Throws:

InvalidOperationException

restart

private long restart(Numbering.Num num,
 long ilvl,
 long val)
              throws InvalidOperationException

Throws:

InvalidOperationException

getEmulator

public Emulator getEmulator()

getEmulator

public Emulator getEmulator(boolean reset)

Parameters:

reset -

Returns:

Since:

3.0.0

getInd

public PPrBase.Ind getInd(PPrBase.NumPr numPr)

getInd

public PPrBase.Ind getInd(String numId,
 String ilvl)

getIndFromLvl

private PPrBase.Ind getIndFromLvl(Lvl lvl)

addAbstractListNumberingDefinition

public Numbering.Num addAbstractListNumberingDefinition(Numbering.AbstractNum abstractNum)

Add the specified definition, allocating it a new w:abstractNumId. Also create and add an associated ListNumberingDefinition, and return this associated ListNumberingDefinition (since that is what you are likely to use in the document).

Parameters:

abstractNum -

Returns:

addAbstractListNumberingDefinitionLevel

public void addAbstractListNumberingDefinitionLevel(Numbering.AbstractNum abstractNum,
 Lvl lvl)

unmarshalDefaultNumbering

public Numbering unmarshalDefaultNumbering()
                                    throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException