|
||||||||||
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.PageNumberField
public class PageNumberField
A PageNumberField displays the current page number of pages in a document.
NOTE: Before the document is opened in any editor, the value of this field is invalid.
Nested Class Summary | |
---|---|
static class |
PageNumberField.DisplayType
A DisplayType represents the selected page attribute of the field. |
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field |
---|
Field.FieldType |
Method Summary | |
---|---|
Field.FieldType |
getFieldType()
Return the type of this field. |
TextPageNumberElement |
getOdfElement()
Return an instance of TextPageNumberElement which represents
this feature. |
void |
setDisplayPage(PageNumberField.DisplayType type)
Specifies whether to display or not the number of a previous or following page rather than the number of the current page. |
void |
setNumberFormat(NumberFormat format)
Specifies the number format of this 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 setDisplayPage(PageNumberField.DisplayType type)
type
- the display type which is predefined.public void setNumberFormat(NumberFormat format)
format
- the format which is predefined in
NumberFormat
.NumberFormat
public TextPageNumberElement getOdfElement()
TextPageNumberElement
which represents
this feature.
getOdfElement
in class Component
TextPageNumberElement
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 |