com.lowagie.text.rtf.field

Class RtfPageNumber

public class RtfPageNumber extends RtfField

The RtfPageNumber provides the page number field in rtf documents.

Version: $Id: RtfPageNumber.java 2776 2007-05-23 20:01:40Z hallm $

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

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 void	writeFieldInstContent(OutputStream out) Writes the field instruction content
protected byte[]	writeFieldResultContent() Writes the field result content
protected void	writeFieldResultContent(OutputStream out) 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()

Deprecated: replaced by writeFieldInstContent

Writes the field instruction content

Returns: A byte array containing "PAGE"

Throws: IOException

writeFieldInstContent

protected void writeFieldInstContent(OutputStream out)

Writes the field instruction content

Throws: IOException

writeFieldResultContent

protected byte[] writeFieldResultContent()

Deprecated: replaced by writeFieldResultContent

Writes the field result content

Returns: An empty byte array

Throws: IOException

writeFieldResultContent

protected void writeFieldResultContent(OutputStream out)

Writes the field result content

Throws: IOException