org.odftoolkit.simple.common.field

Class PageCountField

java.lang.Object

org.odftoolkit.simple.Component

org.odftoolkit.simple.common.field.Field

org.odftoolkit.simple.common.field.PageCountField

public class PageCountField
extends Field

A PageCountField displays the total number of pages in a document. The value of this field is from the owner document meta statistic information.

NOTE: Before the document is opened in any editor, the value of this field maybe invalid.

Since:

0.5

Nested Class Summary

Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field

Field.FieldType

Method Summary

Modifier and Type	Method and Description
Field.FieldType	getFieldType() Return the type of this field.
TextPageCountElement	getOdfElement() Return an instance of TextPageCountElement which represents this feature.
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

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 TextPageCountElement getOdfElement()

Return an instance of TextPageCountElement which represents this feature.

Specified by:

getOdfElement in class Component

Returns:

an instance of TextPageCountElement

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.