org.odftoolkit.simple.common.field
Enum VariableField.VariableType
java.lang.Object
java.lang.Enum<VariableField.VariableType>
org.odftoolkit.simple.common.field.VariableField.VariableType
- All Implemented Interfaces:
- Serializable, Comparable<VariableField.VariableType>
- Enclosing class:
- VariableField
public static enum VariableField.VariableType
- extends Enum<VariableField.VariableType>
A VariableType represents the type of the variable field. There
are three types of variables:
- SIMPLE: Simple variables, or variables, can take different values at
different positions throughout a document. Simple variables can be used
to display different text in recurring elements, such as headers or
footers.
- USER: User variables have the same value throughout a document. If a
user variable is set anywhere within the document, all fields in the
document that display the user variable have the same value.
- SEQUENCE: Sequence variables are used to number items in an ODF text
document. NOTE: Simple Java API for ODF doesn't support this type now.
- Since:
- 0.5
SIMPLE
public static final VariableField.VariableType SIMPLE
USER
public static final VariableField.VariableType USER
SEQUENCE
public static final VariableField.VariableType SEQUENCE
values
public static VariableField.VariableType[] 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 (VariableField.VariableType c : VariableField.VariableType.values())
System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in
the order they are declared
valueOf
public static VariableField.VariableType 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
toString
public String toString()
- Overrides:
toString
in class Enum<VariableField.VariableType>
Copyright © 2010-2017 The Apache Software Foundation. All Rights Reserved.