/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xwpf.usermodel;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;
import javax.xml.namespace.QName;
import org.apache.poi.POIXMLDocumentPart;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackageRelationship;
import org.apache.xmlbeans.XmlOptions;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocProtect;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSettings;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STDocProtect;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.SettingsDocument;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTZoom;
public class XWPFSettings extends POIXMLDocumentPart {
private CTSettings ctSettings;
public XWPFSettings(PackagePart part, PackageRelationship rel) throws IOException {
super(part, rel);
readFrom(part.getInputStream());
}
public XWPFSettings() {
super();
ctSettings = CTSettings.Factory.newInstance();
}
/**
* 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
*
* <w:settings ... > * <w:documentProtection w:edit="readOnly" w:enforcement="1"/> ** * @return true if documentProtection is enforced with option readOnly */ public boolean isEnforcedWith(STDocProtect.Enum editValue) { CTDocProtect ctDocProtect = ctSettings.getDocumentProtection(); if (ctDocProtect == null) { return false; } return ctDocProtect.getEnforcement().equals(STOnOff.X_1) && ctDocProtect.getEdit().equals(editValue); } /** * Enforces the protection with the option specified by passed editValue.
* <w:settings ... > * <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/> **/ public void setEnforcementEditValue(org.openxmlformats.schemas.wordprocessingml.x2006.main.STDocProtect.Enum editValue) { safeGetDocumentProtection().setEnforcement(STOnOff.X_1); safeGetDocumentProtection().setEdit(editValue); } /** * Removes protection enforcement.
* <w:zoom w:percent="50" /> ** @return percentage as an integer of zoom level */ public java.math.BigInteger getZoomPercent() { CTZoom zoom; if (!ctSettings.isSetZoom()) { zoom = ctSettings.addNewZoom(); } else { zoom = ctSettings.getZoom(); } return zoom.getPercent(); } /** * Set zoom.
* In the zoom tag inside settings.xml file
* it sets the value of zoom *
* sample snippet from settings.xml ** <w:zoom w:percent="50" /> ** @return percentage as an integer of zoom level */ public void setZoomPercent(java.math.BigInteger zoomPercent) { if (ctSettings.isSetZoom()) { ctSettings.unsetZoom(); } CTZoom zoom = ctSettings.addNewZoom(); zoom.setPercent(zoomPercent); } }