org.docx4j.openpackaging.packages

Class WordprocessingMLPackage

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.packages.OpcPackage

org.docx4j.openpackaging.packages.WordprocessingMLPackage

All Implemented Interfaces:

PackageIdentifier

Direct Known Subclasses:

WordprocessingMLTemplatePackage

public class WordprocessingMLPackage
extends OpcPackage

Author:

jharrop

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WordprocessingMLPackage.FilterSettings

Field Summary

Fields

Modifier and Type	Field and Description
protected GlossaryDocumentPart	glossaryDoc
protected static org.slf4j.Logger	log
protected MainDocumentPart	mainDoc

Fields inherited from class org.docx4j.openpackaging.packages.OpcPackage

contentTypeManager, customXmlDataStorageParts, docPropsCorePart, docPropsCustomPart, docPropsExtendedPart, externalResources, handled, parts

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor and Description
WordprocessingMLPackage() Constructor.
WordprocessingMLPackage(ContentTypeManager contentTypeManager) Constructor.

Method Summary

Modifier and Type	Method and Description
void	attachTemplate(String templatePath) Attach a template to this document.
static WordprocessingMLPackage	createPackage() Creates a WordprocessingMLPackage, using default page size and orientation.
static WordprocessingMLPackage	createPackage(PageSizePaper sz, boolean landscape) Creates a WordprocessingMLPackage, containing a MainDocumentPart (with content), Styles part, DocPropsCorePart part, and DocPropsExtendedPart.
void	filter(WordprocessingMLPackage.FilterSettings filterSettings) Deprecated.
protected void	finalize()
DocumentModel	getDocumentModel()
Mapper	getFontMapper()
HeaderFooterPolicy	getHeaderFooterPolicy() Deprecated.
MainDocumentPart	getMainDocumentPart()
ProtectDocument	getProtectionSettings()
static WordprocessingMLPackage	load(File docxFile) Convenience method to create a WordprocessingMLPackage from an existing File (.docx zip or .xml Flat OPC).
static WordprocessingMLPackage	load(InputStream is) Convenience method to create a WordprocessingMLPackage from an existing stream(.docx zip or .xml Flat OPC).
void	reset() Reinit fields so this pkg object can be re-used.
void	setFontMapper(Mapper fm)
void	setFontMapper(Mapper fm, boolean populate)
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.
void	transform(Templates xslt, Map<String,Object> transformParameters) Use an XSLT to alter the contents of this package.

Methods inherited from class org.docx4j.openpackaging.packages.OpcPackage

addDocPropsCorePart, addDocPropsCustomPart, addDocPropsExtendedPart, clone, cloneAs, getContentTypeManager, getCustomXmlDataStorageParts, getDocPropsCorePart, getDocPropsCustomPart, getDocPropsExtendedPart, getExternalResources, getPackage, getParts, getSourcePartStore, getTargetPartStore, getTitle, isNew, load, load, load, load, load, load, load, load, load, load, name, save, save, save, save, save, save, setContentTypeManager, setName, setNew, setSourcePartStore, setTargetPartStore, setTitle

Methods inherited from class org.docx4j.openpackaging.Base

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

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

mainDoc

protected MainDocumentPart mainDoc

glossaryDoc

protected GlossaryDocumentPart glossaryDoc

Constructor Detail

WordprocessingMLPackage

public WordprocessingMLPackage()

Constructor. Also creates a new content type manager

WordprocessingMLPackage

public WordprocessingMLPackage(ContentTypeManager contentTypeManager)

Constructor.

Parameters:

contentTypeManager - The content type manager to use

Method Detail

getProtectionSettings

public ProtectDocument getProtectionSettings()

getDocumentModel

public DocumentModel getDocumentModel()

getHeaderFooterPolicy

@Deprecated
public HeaderFooterPolicy getHeaderFooterPolicy()

Deprecated.

load

public static WordprocessingMLPackage load(File docxFile)
                                    throws Docx4JException

Convenience method to create a WordprocessingMLPackage from an existing File (.docx zip or .xml Flat OPC).

Parameters:

docxFile - The docx file

Throws:

Docx4JException

load

public static WordprocessingMLPackage load(InputStream is)
                                    throws Docx4JException

Convenience method to create a WordprocessingMLPackage from an existing stream(.docx zip or .xml Flat OPC).

Parameters:

docxFile - The docx file

Throws:

Docx4JException

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 OpcPackage

Returns:

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

getMainDocumentPart

public MainDocumentPart getMainDocumentPart()

transform

public void transform(Templates xslt,
                      Map<String,Object> transformParameters)
               throws Exception

Use an XSLT to alter the contents of this package. The output of the transformation must be valid pck:package/pck:part format, as emitted by Word 2007.

Parameters:

is -

transformParameters -

Throws:

Exception

filter

@Deprecated
public void filter(WordprocessingMLPackage.FilterSettings filterSettings)
                        throws Exception

Deprecated.

Throws:

Exception

setFontMapper

public void setFontMapper(Mapper fm)
                   throws Exception

Throws:

Exception

setFontMapper

public void setFontMapper(Mapper fm,
                          boolean populate)
                   throws Exception

Parameters:

fm -

populate -

Throws:

Exception

Since:

3.0.1

getFontMapper

public Mapper getFontMapper()

createPackage

public static WordprocessingMLPackage createPackage()
                                             throws InvalidFormatException

Creates a WordprocessingMLPackage, using default page size and orientation. From 2.7.1, these are read from docx4j.properties, or if not found, default to A4 portrait. The WordprocessingMLPackage contains a MainDocumentPart (with content), Styles part, DocPropsCorePart part, and DocPropsExtendedPart.

Throws:

InvalidFormatException

createPackage

public static WordprocessingMLPackage createPackage(PageSizePaper sz,
                                                    boolean landscape)
                                             throws InvalidFormatException

Creates a WordprocessingMLPackage, containing a MainDocumentPart (with content), Styles part, DocPropsCorePart part, and DocPropsExtendedPart. The content contains sectPr specifying paper size and orientation.

Parameters:

sz -

landscape -

Returns:

Throws:

InvalidFormatException

attachTemplate

public void attachTemplate(String templatePath)

Attach a template to this document. This is just an easy way to access the same method in DocumentSettingsPart (which lives under the MainDocumentPart)

Parameters:

templatePath -

Since:

6.1.0

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

reset

public void reset()

Reinit fields so this pkg object can be re-used.

Overrides:

reset in class OpcPackage

Since:

3.3.7