org.odftoolkit.simple.common.field
public class VariableField extends Field
Modifier and Type | Class and Description |
---|---|
static class |
VariableField.VariableType
A VariableType represents the type of the variable field.
|
Field.FieldType
Modifier and Type | Method and Description |
---|---|
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.
|
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent
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
Copyright © 2010-2014 The Apache Software Foundation. All Rights Reserved.