org.docx4j.wml

Enum STDocProtect

java.lang.Object

java.lang.Enum<STDocProtect>

org.docx4j.wml.STDocProtect

All Implemented Interfaces:

Serializable, Comparable<STDocProtect>

public enum STDocProtect
extends Enum<STDocProtect>

Java class for ST_DocProtect.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="ST_DocProtect">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="none"/>
     <enumeration value="readOnly"/>
     <enumeration value="comments"/>
     <enumeration value="trackedChanges"/>
     <enumeration value="forms"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMENTS Allow Editing of Comments
FORMS Allow Editing of Form Fields
NONE No Editing Restrictions
READ_ONLY Allow No Editing
TRACKED_CHANGES Allow Editing With Revision Tracking

Method Summary

Modifier and Type	Method and Description
static STDocProtect	fromValue(String v)
String	value()
static STDocProtect	valueOf(String name) Returns the enum constant of this type with the specified name.
static STDocProtect[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final STDocProtect NONE

No Editing Restrictions

READ_ONLY

public static final STDocProtect READ_ONLY

Allow No Editing

COMMENTS

public static final STDocProtect COMMENTS

Allow Editing of Comments

TRACKED_CHANGES

public static final STDocProtect TRACKED_CHANGES

Allow Editing With Revision Tracking

FORMS

public static final STDocProtect FORMS

Allow Editing of Form Fields

Method Detail

values

public static STDocProtect[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (STDocProtect c : STDocProtect.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static STDocProtect valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static STDocProtect fromValue(String v)