|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.simple.Component
org.odftoolkit.simple.common.field.Field
org.odftoolkit.simple.common.field.VariableField
public class VariableField
ODF document can contain variables, which are processed or displayed as VariableFields. In an ODF file, variable declarations shall precede in document order any use of those variable declarations.
Nested Class Summary | |
---|---|
static class |
VariableField.VariableType
A VariableType represents the type of the variable field. |
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field |
---|
Field.FieldType |
Method Summary | |
---|---|
void |
displayField(OdfElement refElement)
Display this variable field after the reference OdfElement. |
Field.FieldType |
getFieldType()
Return the type of this field. |
OdfElement |
getOdfElement()
Return the instance of OdfElement which presents this structure. |
String |
getVariableName()
Get the variable field name. |
void |
updateField(String value,
OdfElement refElement)
Reset the value of this variable field after the reference OdfElement. |
Methods inherited from class org.odftoolkit.simple.Component |
---|
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void updateField(String value, OdfElement refElement)
Note: For user variable, the value of all fields in the document that display the user variable will be reset.
value
- the new value of this variable field.refElement
- the reference OdfElement. The variable field will be appended
after this element. For user variable, this parameter can be
null.public void displayField(OdfElement refElement)
refElement
- the reference OdfElement. The variable field will be appended
after this element.public String getVariableName()
public OdfElement getOdfElement()
Component
getOdfElement
in class Component
public Field.FieldType getFieldType()
Field
getFieldType
in class Field
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |