public class XWPFSettings extends POIXMLDocumentPart
DEFAULT_XML_OPTIONS
Constructor | Description |
---|---|
XWPFSettings() |
|
XWPFSettings(PackagePart part,
PackageRelationship rel) |
Modifier and Type | Method | Description |
---|---|---|
protected void |
commit() |
Save the content in the underlying package part.
|
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(org.openxmlformats.schemas.wordprocessingml.x2006.main.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) sample snippet from settings.xml |
protected void |
onDocumentRead() |
Fired when a package part is read
|
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(org.openxmlformats.schemas.wordprocessingml.x2006.main.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 |
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 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString
public XWPFSettings(PackagePart part, PackageRelationship rel) throws java.io.IOException
java.io.IOException
public XWPFSettings()
protected void onDocumentRead() throws java.io.IOException
POIXMLDocumentPart
onDocumentRead
in class POIXMLDocumentPart
java.io.IOException
public long getZoomPercent()
<w:zoom w:percent="50" />
public void setZoomPercent(long zoomPercent)
<w:zoom w:percent="50" />
public boolean isEnforcedWith(org.openxmlformats.schemas.wordprocessingml.x2006.main.STDocProtect.Enum editValue)
<w:settings ... > <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
public void setEnforcementEditValue(org.openxmlformats.schemas.wordprocessingml.x2006.main.STDocProtect.Enum editValue)
<w:settings ... > <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/>
public void removeEnforcement()
public void setUpdateFields()
protected void commit() throws java.io.IOException
POIXMLDocumentPart
protected void commit() throws IOException {
PackagePart part = getPackagePart();
OutputStream out = part.getOutputStream();
XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
bean.save(out, DEFAULT_XML_OPTIONS);
out.close();
}
commit
in class POIXMLDocumentPart
java.io.IOException
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.