com.lowagie.text.rtf.field

Class RtfPageNumber

public class RtfPageNumber extends RtfField

The RtfPageNumber provides the page number field in rtf documents.

Version: $Revision: 1.9 $

Author: Mark Hall (mhall@edu.uni-klu.ac.at) Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)

Field Summary
static byte[]PAGE_NUMBER
Constant for the page number
Constructor Summary
RtfPageNumber()
Constructs a RtfPageNumber.
RtfPageNumber(Font font)
Constructs a RtfPageNumber with a specified Font.
RtfPageNumber(RtfDocument doc)
Constructs a RtfPageNumber object.
RtfPageNumber(RtfDocument doc, Font font)
Constructs a RtfPageNumber object with a specific font.
Method Summary
protected byte[]writeFieldInstContent()
Writes the field instruction content
protected byte[]writeFieldResultContent()
Writes the field result content

Field Detail

PAGE_NUMBER

private static final byte[] PAGE_NUMBER
Constant for the page number

Constructor Detail

RtfPageNumber

public RtfPageNumber()
Constructs a RtfPageNumber. This can be added anywhere to add a page number field.

RtfPageNumber

public RtfPageNumber(Font font)
Constructs a RtfPageNumber with a specified Font. This can be added anywhere to add a page number field.

Parameters: font

RtfPageNumber

public RtfPageNumber(RtfDocument doc)
Constructs a RtfPageNumber object.

Parameters: doc The RtfDocument this RtfPageNumber belongs to

RtfPageNumber

public RtfPageNumber(RtfDocument doc, Font font)
Constructs a RtfPageNumber object with a specific font.

Parameters: doc The RtfDocument this RtfPageNumber belongs to font The Font to use

Method Detail

writeFieldInstContent

protected byte[] writeFieldInstContent()
Writes the field instruction content

Returns: A byte array containing "PAGE"

Throws: IOException

writeFieldResultContent

protected byte[] writeFieldResultContent()
Writes the field result content

Returns: An empty byte array

Throws: IOException