org.docx4j.wml

Enum HdrFtrRef

java.lang.Object

java.lang.Enum<HdrFtrRef>

org.docx4j.wml.HdrFtrRef

All Implemented Interfaces:

Serializable, Comparable<HdrFtrRef>

public enum HdrFtrRef
extends Enum<HdrFtrRef>

Java class for HdrFtrRef.

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

 <simpleType name="HdrFtrRef">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="even"/>
     <enumeration value="default"/>
     <enumeration value="first"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Default Header or Footer
EVEN Even Numbered Pages Only
FIRST First Page Only

Method Summary

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

EVEN

public static final HdrFtrRef EVEN

Even Numbered Pages Only

DEFAULT

public static final HdrFtrRef DEFAULT

Default Header or Footer

FIRST

public static final HdrFtrRef FIRST

First Page Only

Method Detail

values

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

Returns:

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

valueOf

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