|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.simple.common.field.Fields
public class Fields
This is a tool class to help the user creating all kinds of fields as needed.
FieldSelection
Method Summary | |
---|---|
static AuthorField |
createAuthorInitialsField(OdfElement odfElement)
Create an author field for the specific OdfElement, which displays the initials of the author of this document. |
static AuthorField |
createAuthorNameField(OdfElement odfElement)
Create an author field for the specific OdfElement, which displays author full name of this document. |
static ChapterField |
createChapterField(OdfElement odfElement)
Create a chapter field for the specific OdfElement. |
static ConditionField |
createConditionField(OdfElement odfElement,
String condition,
String trueText,
String falseText)
Declare a condition field, which specifies a condition for display of one text string or another. |
static PageNumberField |
createCurrentPageNumberField(OdfElement odfElement)
Create a page number field for the specific OdfElement, which displays current page number. |
static DateField |
createDateField(OdfElement odfElement)
Create an automatically update date field for the specific OdfElement, which displays current date. |
static DateField |
createFixedDateField(OdfElement odfElement)
Create a fixed date field for the specific OdfElement, which displays the field created date. |
static TimeField |
createFixedTimeField(OdfElement odfElement)
Create a fixed time field for the specific OdfElement, which displays the field created time. |
static ConditionField |
createHiddenTextField(OdfElement odfElement,
String condition,
String text)
Declare a hidden text field, which hides the text it contains when a specified condition is true. |
static PageNumberField |
createNextPageNumberField(OdfElement odfElement)
Create a page number field for the specific OdfElement, which displays next page number. |
static PageCountField |
createPageCountField(OdfElement odfElement)
Create a page count field for the specific OdfElement, which displays page total count of this document. |
static PageNumberField |
createPreviousPageNumberField(OdfElement odfElement)
Create a page number field for the specific OdfElement, which displays previous page number. |
static ReferenceField |
createReferenceField(OdfElement odfElement,
String referenceName)
Create a ReferenceField for the specific OdfElement. |
static VariableField |
createSimpleVariableField(VariableContainer container,
String name)
Declare a simple variable field. |
static SubjectField |
createSubjectField(OdfElement odfElement)
Create a subject field for the specific OdfElement, which displays the subject data of this document. |
static TimeField |
createTimeField(OdfElement odfElement)
Create an automatically update time field for the specific OdfElement, which displays current time. |
static TitleField |
createTitleField(OdfElement odfElement)
Create a title field for the specific OdfElement, which displays title data of this document. |
static VariableField |
createUserVariableField(VariableContainer container,
String name,
String value)
Declare a user variable field. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DateField createDateField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static DateField createFixedDateField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static TimeField createTimeField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static TimeField createFixedTimeField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static PageNumberField createPreviousPageNumberField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static PageNumberField createCurrentPageNumberField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static PageNumberField createNextPageNumberField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static PageCountField createPageCountField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static TitleField createTitleField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static SubjectField createSubjectField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static AuthorField createAuthorNameField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static AuthorField createAuthorInitialsField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static ChapterField createChapterField(OdfElement odfElement)
odfElement
- the OdfElement which owns this field.
public static ReferenceField createReferenceField(OdfElement odfElement, String referenceName)
odfElement
- the OdfElement which owns this field.referenceName
- the reference field name.
public static VariableField createSimpleVariableField(VariableContainer container, String name)
Simple variables can be used to display different text in recurring elements, such as headers or footers.
container
- the container which this variable field is contained.name
- the name of this variable field.
public static VariableField createUserVariableField(VariableContainer container, String name, String value)
container
- the container which this variable field is contained.name
- the name of this variable field.value
- the initial value of this variable field.
public static ConditionField createConditionField(OdfElement odfElement, String condition, String trueText, String falseText)
odfElement
- the OdfElement which owns this field.condition
- the condition that determines which of the two text strings is
displayed.trueText
- the text string to display if a condition
is
true.falseText
- the text string to display if a condition
is
false.
public static ConditionField createHiddenTextField(OdfElement odfElement, String condition, String text)
odfElement
- the OdfElement which owns this field.condition
- the condition that determines whether the text string is
displayed or not.text
- the text string to display.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |