org.odftoolkit.simple.common.field
Class PageNumberField

java.lang.Object
  org.odftoolkit.simple.Component
      org.odftoolkit.simple.common.field.Field
          org.odftoolkit.simple.common.field.PageNumberField

public class PageNumberField
extends Field

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.

Since:

0.5

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

setDisplayPage

public 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.

Parameters:

type - the display type which is predefined.

setNumberFormat

public void setNumberFormat(NumberFormat format)

Specifies the number format of this field.

Parameters:

format - the format which is predefined in NumberFormat.

See Also:

NumberFormat

getOdfElement

public TextPageNumberElement getOdfElement()

Return an instance of TextPageNumberElement which represents this feature.

Specified by:

getOdfElement in class Component

Returns:

an instance of TextPageNumberElement

getFieldType

public Field.FieldType getFieldType()

Description copied from class: Field

Return the type of this field.

Specified by:

getFieldType in class Field

Returns:

the type of this field.