org.docx4j.openpackaging.parts.WordprocessingML

Class DocumentSettingsPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

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

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

org.docx4j.openpackaging.parts.WordprocessingML.DocumentSettingsPart

All Implemented Interfaces:

XPathEnabled<CTSettings>

public final class DocumentSettingsPart
extends JaxbXmlPartXPathAware<CTSettings>

Field Summary

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
DocumentSettingsPart()
DocumentSettingsPart(PartName partName)

Method Summary

Modifier and Type	Method and Description
void	attachTemplate(String templatePath)
String	getMceIgnorable()
CTCompatSetting	getWordCompatSetting(String name) Get a compatibility setting in the Word namespace, by name
void	init()
boolean	isRestrictEditingWith(STDocProtect editValue) Verifies the documentProtection tag inside settings.xml file if the protection is enforced (w:enforcement="1") and if the kind of protection equals to passed (STDocProtect.Enum editValue)
boolean	overrideTableStyleFontSizeAndJustification() Get the value of compatSetting overrideTableStyleFontSizeAndJustification
void	protectRestrictEditing(STDocProtect editValue, String password, HashAlgorithm hashAlgo) Enforces the protection with the option specified by passed editValue, password, and HashAlgorithm for the password.
void	protectRestrictFormatting(boolean autoFormatOverride, boolean styleLockTheme, boolean styleLockQFSet, String password, HashAlgorithm hashAlgo) Restrict allowed formatting to specified styles.
void	removeEnforcement() Removes protection enforcement. In the documentProtection tag inside settings.xml file it sets the value of enforcement to "0" (w:enforcement="0")
protected void	setMceIgnorable(McIgnorableNamespaceDeclarator namespacePrefixMapper) Where the mc:Ignorable attribute is present, ensure its contents matches the ignorable namespaces actually present.
void	setOverrideTableStyleFontSizeAndJustification(boolean val)
void	setWordCompatSetting(String name, String val)
boolean	validateProtectionPassword(String password) Validates the existing password

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, getXML, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, setContents, setJAXBContext, setJaxbElement, transform, 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

Constructor Detail

DocumentSettingsPart

public DocumentSettingsPart(PartName partName)
                     throws InvalidFormatException

Throws:

InvalidFormatException

DocumentSettingsPart

public DocumentSettingsPart()
                     throws InvalidFormatException

Throws:

InvalidFormatException

Method Detail

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<CTSettings>

getMceIgnorable

public String getMceIgnorable()

Overrides:

getMceIgnorable in class JaxbXmlPart<CTSettings>

getWordCompatSetting

public CTCompatSetting getWordCompatSetting(String name)

Get a compatibility setting in the Word namespace, by name

Parameters:

name -

Returns:

Throws:

Docx4JException

setWordCompatSetting

public void setWordCompatSetting(String name,
                                 String val)

overrideTableStyleFontSizeAndJustification

public boolean overrideTableStyleFontSizeAndJustification()

Get the value of compatSetting overrideTableStyleFontSizeAndJustification

Since:

3.3.0

setOverrideTableStyleFontSizeAndJustification

public void setOverrideTableStyleFontSizeAndJustification(boolean val)

protectRestrictFormatting

public void protectRestrictFormatting(boolean autoFormatOverride,
                                      boolean styleLockTheme,
                                      boolean styleLockQFSet,
                                      String password,
                                      HashAlgorithm hashAlgo)
                               throws Docx4JException

Restrict allowed formatting to specified styles. You don't want to use this directly; use the method with the same name in WordprocessingMLPackage

Parameters:

allowedStyleNames -

autoFormatOverride -

styleLockTheme -

styleLockQFSet -

Throws:

Docx4JException

Since:

3.3.0

isRestrictEditingWith

public boolean isRestrictEditingWith(STDocProtect editValue)

Verifies the documentProtection tag inside settings.xml file if the protection is enforced (w:enforcement="1") and if the kind of protection equals to passed (STDocProtect.Enum editValue)

Returns:

true if documentProtection is enforced with option readOnly

Since:

3.3.0

protectRestrictEditing

public void protectRestrictEditing(STDocProtect editValue,
                                   String password,
                                   HashAlgorithm hashAlgo)

Enforces the protection with the option specified by passed editValue, password, and HashAlgorithm for the password.

Parameters:

editValue - the protection type

password - the plaintext password, if null no password will be applied

hashAlgo - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported. if null, it will default default to sha512 (like Word 2013)

Since:

3.3.0

validateProtectionPassword

public boolean validateProtectionPassword(String password)

Validates the existing password

Parameters:

password -

Returns:

true, only if password was set and equals, false otherwise

Since:

3.3.0

removeEnforcement

public void removeEnforcement()

Removes protection enforcement.
In the documentProtection tag inside settings.xml file
it sets the value of enforcement to "0" (w:enforcement="0")

Since:

3.3.0

attachTemplate

public void attachTemplate(String templatePath)

Parameters:

templatePath -

Since:

6.1.0