public class

PageNumber

extends ContentElement
java.lang.Object
   ↳ com.pdftron.layout.ContentElement
     ↳ com.pdftron.layout.PageNumber

Class Overview

A PageNumber is a content element whose text is generated during pagination.

It displays either the number of the page it ends up on, or the total number of pages of the document.

Summary

Nested Classes
enum PageNumber.NumberFormat The formatting applied to the generated number. 
enum PageNumber.NumberType The kind of number a PageNumber displays. 
Public Methods
PageNumber.NumberFormat getNumberFormat()
PageNumber.NumberType getNumberType()
void setNumberFormat(PageNumber.NumberFormat format)
Sets the formatting applied to the generated number.
void setNumberType(PageNumber.NumberType type)
Sets the kind of number this element displays.
[Expand]
Inherited Methods
From class com.pdftron.layout.ContentElement
From class java.lang.Object

Public Methods

public PageNumber.NumberFormat getNumberFormat ()

Returns
  • The formatting applied to the generated number

public PageNumber.NumberType getNumberType ()

Returns
  • The kind of number this element displays

public void setNumberFormat (PageNumber.NumberFormat format)

Sets the formatting applied to the generated number.

Parameters
format The number formatting

public void setNumberType (PageNumber.NumberType type)

Sets the kind of number this element displays.

Parameters
type The kind of number