org.docx4j.wml

Enum STDocGrid

java.lang.Object

java.lang.Enum<STDocGrid>

org.docx4j.wml.STDocGrid

All Implemented Interfaces:

Serializable, Comparable<STDocGrid>

public enum STDocGrid
extends Enum<STDocGrid>

Java class for ST_DocGrid.

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

 <simpleType name="ST_DocGrid">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="default"/>
     <enumeration value="lines"/>
     <enumeration value="linesAndChars"/>
     <enumeration value="snapToChars"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT No Document Grid
LINES Line Grid Only
LINES_AND_CHARS Line and Character Grid
SNAP_TO_CHARS Character Grid Only

Method Summary

Methods

Modifier and Type	Method and Description
static STDocGrid	fromValue(String v)
String	value()
static STDocGrid	valueOf(String name) Returns the enum constant of this type with the specified name.
static STDocGrid[]	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

DEFAULT

public static final STDocGrid DEFAULT

No Document Grid

LINES

public static final STDocGrid LINES

Line Grid Only

LINES_AND_CHARS

public static final STDocGrid LINES_AND_CHARS

Line and Character Grid

SNAP_TO_CHARS

public static final STDocGrid SNAP_TO_CHARS

Character Grid Only

Method Detail

values

public static STDocGrid[] 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 (STDocGrid c : STDocGrid.values())
    System.out.println(c);

Returns:

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

valueOf

public static STDocGrid 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 STDocGrid fromValue(String v)