Class RtfPageNumber

java.lang.Object

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfPageNumber

public class RtfPageNumber
extends RtfContainer

Page number container.

This work was authored by Christopher Scott (scottc@westinghouse.com).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RTF_FIELD	constant for field
static final String	RTF_FIELD_PAGE	constant for field on page
static final String	RTF_FIELD_RESULT	constant for field result

Fields inherited from class RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfPageNumber(IRtfPageNumberContainer parent, Writer w)	Create an RTF paragraph as a child of given container with default attributes
RtfPageNumber(RtfContainer parent, Writer w, RtfAttributes attrs)	Create an RTF page number as a child of given container with given attributes
RtfPageNumber(RtfParagraph parent, Writer w)	Create an RTF page number as a child of given paragraph, copying the paragraph attributes

Method Summary

Modifier and Type	Method	Description
boolean	isEmpty()
protected void	writeRtfContent()	Write our attributes and content

Methods inherited from class RtfContainer

addChild, containsText, dump, findChildren, getChildCount, getChildren, getOptions, okToWriteRtf, setChildren, setOptions, toString

Methods inherited from class RtfElement

close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

RTF_FIELD

public static final String RTF_FIELD

constant for field

See Also:

• Constant Field Values

RTF_FIELD_PAGE

public static final String RTF_FIELD_PAGE

constant for field on page

See Also:

• Constant Field Values

RTF_FIELD_RESULT

public static final String RTF_FIELD_RESULT

constant for field result

See Also:

• Constant Field Values

Constructor Details

RtfPageNumber

RtfPageNumber(IRtfPageNumberContainer parent,
 Writer w)
       throws IOException

Create an RTF paragraph as a child of given container with default attributes

Throws:

IOException

RtfPageNumber

RtfPageNumber(RtfContainer parent,
 Writer w,
 RtfAttributes attrs)
       throws IOException

Create an RTF page number as a child of given container with given attributes

Throws:

IOException

RtfPageNumber

RtfPageNumber(RtfParagraph parent,
 Writer w)
       throws IOException

Create an RTF page number as a child of given paragraph, copying the paragraph attributes

Throws:

IOException

Method Details

writeRtfContent

protected void writeRtfContent()
                        throws IOException

Write our attributes and content

Overrides:

writeRtfContent in class RtfContainer

Throws:

IOException - for I/O problems

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class RtfContainer

Returns:

true if this element would generate no "useful" RTF content