com.lowagie.text.rtf.field

Class RtfTotalPageNumber

public class RtfTotalPageNumber extends RtfField

The RtfTotalPageNumber provides the total number of pages field in rtf documents.

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

Author: Jose Hurtado (jose.hurtado@gft.com) Mark Hall (mhall@edu.uni-klu.ac.at) Thomas Bickel (tmb99@inode.at)

Field Summary
static byte[]ARABIC_TOTAL_PAGES
Constant for arabic total page numbers.
Constructor Summary
RtfTotalPageNumber()
Constructs a RtfTotalPageNumber.
RtfTotalPageNumber(Font font)
Constructs a RtfTotalPageNumber with a specified Font.
RtfTotalPageNumber(RtfDocument doc)
Constructs a RtfTotalPageNumber object.
RtfTotalPageNumber(RtfDocument doc, Font font)
Constructs a RtfTotalPageNumber object with a specific font.
Method Summary
protected byte[]writeFieldInstContent()
Writes the field NUMPAGES instruction with Arabic format
protected voidwriteFieldInstContent(OutputStream out)
Writes the field NUMPAGES instruction with Arabic format: "NUMPAGES \\\\* Arabic".
protected byte[]writeFieldResultContent()
Writes the field result content
protected voidwriteFieldResultContent(OutputStream out)
Writes the field result content "1"

Field Detail

ARABIC_TOTAL_PAGES

private static final byte[] ARABIC_TOTAL_PAGES
Constant for arabic total page numbers.

Constructor Detail

RtfTotalPageNumber

public RtfTotalPageNumber()
Constructs a RtfTotalPageNumber. This can be added anywhere to add a total number of pages field.

RtfTotalPageNumber

public RtfTotalPageNumber(Font font)
Constructs a RtfTotalPageNumber with a specified Font. This can be added anywhere to add a total number of pages field.

Parameters: font

RtfTotalPageNumber

public RtfTotalPageNumber(RtfDocument doc)
Constructs a RtfTotalPageNumber object.

Parameters: doc The RtfDocument this RtfTotalPageNumber belongs to

RtfTotalPageNumber

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

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

Method Detail

writeFieldInstContent

protected byte[] writeFieldInstContent()

Deprecated:

Writes the field NUMPAGES instruction with Arabic format

Returns: A byte array containing "NUMPAGES \\\\* Arabic".

Throws: IOException

writeFieldInstContent

protected void writeFieldInstContent(OutputStream out)
Writes the field NUMPAGES instruction with Arabic format: "NUMPAGES \\\\* Arabic".

writeFieldResultContent

protected byte[] writeFieldResultContent()

Deprecated:

Writes the field result content

Returns: An byte array containing "1".

Throws: IOException

writeFieldResultContent

protected void writeFieldResultContent(OutputStream out)
Writes the field result content "1"