org.docx4j.openpackaging.parts.WordprocessingML

Class DocumentPart<E>

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

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

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

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

org.docx4j.openpackaging.parts.WordprocessingML.DocumentPart<E>

All Implemented Interfaces:

AltChunkInterface, XPathEnabled<E>

Direct Known Subclasses:

GlossaryDocumentPart, MainDocumentPart

public abstract class DocumentPart<E>
extends JaxbXmlPartAltChunkHost<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected CommentsExtendedPart	commentsExtendedPart
protected CommentsIdsPart	commentsIdsPart
protected CommentsPart	commentsPart Parts which can be the target of a relationship from either the Main Document or the Glossary Document Microsoft's Microsoft.Office.DocumentFormat.OpenXML has no equivalent of this.
protected DocumentSettingsPart	documentSettingsPart
protected EndnotesPart	endNotesPart
protected FontTablePart	fontTablePart
protected FootnotesPart	footnotesPart
protected static org.slf4j.Logger	log
protected NumberingDefinitionsPart	numberingDefinitionsPart
protected PeoplePart	peoplePart
protected StyleDefinitionsPart	styleDefinitionsPart
protected ThemePart	themePart
protected WebSettingsPart	webSettingsPart

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 and Description
DocumentPart(PartName partName) Other characteristics which both the Main Document and the Glossary Document have.

Method Summary

Modifier and Type	Method and Description
BibliographyPart	getBibliographyPart()
CommentsExtendedPart	getCommentsExtendedPart()
CommentsIdsPart	getCommentsIdsPart()
CommentsPart	getCommentsPart()
ComponentsPart	getComponentsPart()
ConditionsPart	getConditionsPart()
DocumentSettingsPart	getDocumentSettingsPart()
DocumentSettingsPart	getDocumentSettingsPart(boolean createIfAbsent)
EndnotesPart	getEndNotesPart()
FontTablePart	getFontTablePart()
static Node	getFootnote(WordprocessingMLPackage wmlPackage, String id) Deprecated.
FootnotesPart	getFootnotesPart()
NumberingDefinitionsPart	getNumberingDefinitionsPart()
PeoplePart	getPeoplePart()
QuestionsPart	getQuestionsPart()
StyleDefinitionsPart	getStyleDefinitionsPart()
StyleDefinitionsPart	getStyleDefinitionsPart(boolean create)
ThemePart	getThemePart()
WebSettingsPart	getWebSettingsPart()
XPathsPart	getXPathsPart()
boolean	hasEndnotesPart() Does this package contain an endnotes part, with real endnotes in it?
boolean	hasFootnotesPart()
boolean	setPartShortcut(Part part)
boolean	setPartShortcut(Part part, String relationshipType) Tell the source Part about this target Part, so the source can use this part via a convenience method.

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

addAltChunk, addAltChunk, addAltChunk, addAltChunk, addAltChunk, addAltChunk, addAltChunk, addAltChunk, convertAltChunks

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, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, setContents, setJAXBContext, setJaxbElement, setMceIgnorable, transform, variableReplace

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

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, 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 Detail

log

protected static org.slf4j.Logger log

commentsPart

protected CommentsPart commentsPart

Parts which can be the target of a relationship from either the Main Document or the Glossary Document Microsoft's Microsoft.Office.DocumentFormat.OpenXML has no equivalent of this.

commentsExtendedPart

protected CommentsExtendedPart commentsExtendedPart

commentsIdsPart

protected CommentsIdsPart commentsIdsPart

documentSettingsPart

protected DocumentSettingsPart documentSettingsPart

endNotesPart

protected EndnotesPart endNotesPart

fontTablePart

protected FontTablePart fontTablePart

peoplePart

protected PeoplePart peoplePart

themePart

protected ThemePart themePart

footnotesPart

protected FootnotesPart footnotesPart

numberingDefinitionsPart

protected NumberingDefinitionsPart numberingDefinitionsPart

styleDefinitionsPart

protected StyleDefinitionsPart styleDefinitionsPart

webSettingsPart

protected WebSettingsPart webSettingsPart

Constructor Detail

DocumentPart

public DocumentPart(PartName partName)
             throws InvalidFormatException

Other characteristics which both the Main Document and the Glossary Document have.

Throws:

InvalidFormatException

Method Detail

setPartShortcut

public boolean setPartShortcut(Part part)

setPartShortcut

public boolean setPartShortcut(Part part,
                               String relationshipType)

Description copied from class: Base

Tell the source Part about this target Part, so the source can use this part via a convenience method.

Overrides:

setPartShortcut in class Part

Returns:

true if the source Part does use the target Part in a convenience method.

getCommentsPart

public CommentsPart getCommentsPart()

getCommentsExtendedPart

public CommentsExtendedPart getCommentsExtendedPart()

getCommentsIdsPart

public CommentsIdsPart getCommentsIdsPart()

getDocumentSettingsPart

public DocumentSettingsPart getDocumentSettingsPart()

getDocumentSettingsPart

public DocumentSettingsPart getDocumentSettingsPart(boolean createIfAbsent)
                                             throws InvalidFormatException

Parameters:

createIfAbsent -

Returns:

Throws:

InvalidFormatException

Since:

3.3.0

getEndNotesPart

public EndnotesPart getEndNotesPart()

hasEndnotesPart

public boolean hasEndnotesPart()

Does this package contain an endnotes part, with real endnotes in it?

Returns:

getFootnotesPart

public FootnotesPart getFootnotesPart()

hasFootnotesPart

public boolean hasFootnotesPart()

getFootnote

@Deprecated
public static Node getFootnote(WordprocessingMLPackage wmlPackage,
                                           String id)

Deprecated.

getFontTablePart

public FontTablePart getFontTablePart()

getNumberingDefinitionsPart

public NumberingDefinitionsPart getNumberingDefinitionsPart()

getPeoplePart

public PeoplePart getPeoplePart()

getStyleDefinitionsPart

public StyleDefinitionsPart getStyleDefinitionsPart()

getStyleDefinitionsPart

public StyleDefinitionsPart getStyleDefinitionsPart(boolean create)

getThemePart

public ThemePart getThemePart()

getWebSettingsPart

public WebSettingsPart getWebSettingsPart()

getConditionsPart

public ConditionsPart getConditionsPart()

getXPathsPart

public XPathsPart getXPathsPart()

getQuestionsPart

public QuestionsPart getQuestionsPart()

getComponentsPart

public ComponentsPart getComponentsPart()

getBibliographyPart

public BibliographyPart getBibliographyPart()