|
||||||||||
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.ReferenceField
public class ReferenceField
A ReferenceField refers to a field that appears in another location in a document.
The advantage of entering a reference as a field is that you do not have to adjust the references manually every time you change the document. Just update the fields and the references in the document are updated too.
NOTE: Before the document is opened in any editor, the value of this field maybe invalid.
Nested Class Summary | |
---|---|
static class |
ReferenceField.DisplayType
A DisplayType specifies the information that a reference field should display. |
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field |
---|
Field.FieldType |
Method Summary | |
---|---|
void |
appendReferenceTo(OdfElement odfEle,
ReferenceField.DisplayType type)
Append this reference field after the specifics OdfElement. |
Field.FieldType |
getFieldType()
Return the type of this field. |
String |
getName()
Get the name of this reference field. |
OdfElement |
getOdfElement()
Return the instance of OdfElement which presents this structure. |
void |
setName(String referenceName)
Set the name of this reference field. |
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 setName(String referenceName)
referenceName
- the name of this content.public String getName()
public void appendReferenceTo(OdfElement odfEle, ReferenceField.DisplayType type)
odfEle
- the reference of odf element.type
- the display type.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 |