public class PageNumberField extends Field
NOTE: Before the document is opened in any editor, the value of this field is invalid.
Modifier and Type | Class and Description |
---|---|
static class |
PageNumberField.DisplayType
A DisplayType represents the selected page attribute of the field.
|
Field.FieldType
Modifier and Type | Method and Description |
---|---|
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.
|
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent
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
Copyright © 2010–2018 Apache Software Foundation; Copyright © 2018–2020 The Document Foundation. All rights reserved.