public class XWPFSettings
extends org.apache.poi.ooxml.POIXMLDocumentPart
Constructor and Description |
---|
XWPFSettings() |
XWPFSettings(PackagePart part) |
Modifier and Type | Method and Description |
---|---|
boolean |
getEvenAndOddHeadings()
Check if separate even and odd headings is turned on.
|
boolean |
getMirrorMargins()
Check if mirrored margins is turned on
|
long |
getZoomPercent()
Set zoom.
In the zoom tag inside settings.xml file it sets the value of zoom sample snippet from settings.xml |
boolean |
isEnforcedWith()
Verifies the documentProtection tag inside settings.xml file
if the protection is enforced (w:enforcement="1") |
boolean |
isEnforcedWith(STDocProtect.Enum 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 |
isTrackRevisions()
Check if revision tracking is turned on.
|
void |
removeEnforcement()
Removes protection enforcement.
In the documentProtection tag inside settings.xml file it sets the value of enforcement to "0" (w:enforcement="0") |
void |
setEnforcementEditValue(STDocProtect.Enum editValue)
Enforces the protection with the option specified by passed editValue.
In the documentProtection tag inside settings.xml file it sets the value of enforcement to "1" (w:enforcement="1") and the value of edit to the passed editValue (w:edit="[passed editValue]") sample snippet from settings.xml |
void |
setEnforcementEditValue(STDocProtect.Enum editValue,
String password,
HashAlgorithm hashAlgo)
Enforces the protection with the option specified by passed editValue and password.
sample snippet from settings.xml |
void |
setEvenAndOddHeadings(boolean enable)
Turn separate even-and-odd headings on or off
|
void |
setMirrorMargins(boolean enable)
Turn mirrored margins on or off
|
void |
setTrackRevisions(boolean enable)
Enable or disable revision tracking.
|
void |
setUpdateFields()
Enforces fields update on document open (in Word).
|
void |
setZoomPercent(long zoomPercent)
Set zoom.
In the zoom tag inside settings.xml file it sets the value of zoom sample snippet from settings.xml |
boolean |
validateProtectionPassword(String password)
Validates the existing password
|
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommited, isCommitted, setCommited, setCommitted, toString
public XWPFSettings(PackagePart part) throws IOException
IOException
public XWPFSettings()
public long getZoomPercent()
<w:zoom w:percent="50" />
public void setZoomPercent(long zoomPercent)
<w:zoom w:percent="50" />
public boolean isEnforcedWith()
sample snippet from settings.xml
<w:settings ... > <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
public boolean isEnforcedWith(STDocProtect.Enum editValue)
sample snippet from settings.xml
<w:settings ... > <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
public void setEnforcementEditValue(STDocProtect.Enum editValue)
<w:settings ... > <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/>
public void setEnforcementEditValue(STDocProtect.Enum editValue, String password, HashAlgorithm hashAlgo)
<w:documentProtection w:edit="[passed editValue]" w:enforcement="1" w:cryptProviderType="rsaAES" w:cryptAlgorithmClass="hash" w:cryptAlgorithmType="typeAny" w:cryptAlgorithmSid="14" w:cryptSpinCount="100000" w:hash="..." w:salt="...." />
editValue
- the protection typepassword
- the plaintext password, if null no password will be appliedhashAlgo
- the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported.
if null, it will default default to sha1public boolean validateProtectionPassword(String password)
password
- public void removeEnforcement()
public void setUpdateFields()
NOTICES:
public boolean isTrackRevisions()
true
if revision tracking is turned onpublic void setTrackRevisions(boolean enable)
enable
- true
to turn on revision tracking, false
to turn off revision trackingpublic boolean getEvenAndOddHeadings()
public void setEvenAndOddHeadings(boolean enable)
enable
- true
to turn on separate even and odd headings,
false
to turn off even and odd headings.public boolean getMirrorMargins()
public void setMirrorMargins(boolean enable)
enable
- true
to turn on mirrored margins,
false
to turn off mirrored marginss.Copyright © 2010 - 2020 Adobe. All Rights Reserved