Class RtfPage

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.RtfPage

public class RtfPage
extends RtfContainer

Specifies rtf control words. Is the container for page attributes. Overrides okToWriteRtf.

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

Field Summary

Fields

Modifier and Type	Field	Description
private final RtfAttributes	attrib
static final String	FOOTERY	constant for footer position
static final String	HEADERY	constant for header position
static final String	ITAP	constant for itap level
static final String	LANDSCAPE	constant for landscape format
static final String	MARGIN_BOTTOM	constant for bottom margin
static final String	MARGIN_LEFT	constant for left margin
static final String	MARGIN_RIGHT	constant for right margin
static final String	MARGIN_TOP	constant for top margin
static final String[]	PAGE_ATTR	String array of RtfPage attributes
static final String	PAGE_HEIGHT	constant for page height
static final String	PAGE_WIDTH	constant for page width

Fields inherited from class RtfElement

parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfPage(RtfPageArea parent, Writer w, RtfAttributes attrs)	RtfPage creates new page attributes with the parent container, the writer and the attributes

Method Summary

Modifier and Type	Method	Description
RtfAttributes	getAttributes()	RtfPage - attributes accessor
protected boolean	okToWriteRtf()	RtfPage - is overwritten here because page attributes have no content only attributes.
protected void	writeRtfContent()	RtfPage writes the attributes the attributes contained in the string PAGE_ATTR, if not null

Methods inherited from class RtfContainer

addChild, containsText, dump, findChildren, getChildCount, getChildren, getOptions, isEmpty, 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

attrib

private final RtfAttributes attrib

PAGE_WIDTH

public static final String PAGE_WIDTH

constant for page width

See Also:

• Constant Field Values

PAGE_HEIGHT

public static final String PAGE_HEIGHT

constant for page height

See Also:

• Constant Field Values

LANDSCAPE

public static final String LANDSCAPE

constant for landscape format

See Also:

• Constant Field Values

MARGIN_TOP

public static final String MARGIN_TOP

constant for top margin

See Also:

• Constant Field Values

MARGIN_BOTTOM

public static final String MARGIN_BOTTOM

constant for bottom margin

See Also:

• Constant Field Values

MARGIN_LEFT

public static final String MARGIN_LEFT

constant for left margin

See Also:

• Constant Field Values

MARGIN_RIGHT

public static final String MARGIN_RIGHT

constant for right margin

See Also:

• Constant Field Values

HEADERY

public static final String HEADERY

constant for header position

See Also:

• Constant Field Values

FOOTERY

public static final String FOOTERY

constant for footer position

See Also:

• Constant Field Values

ITAP

public static final String ITAP

constant for itap level

See Also:

• Constant Field Values

PAGE_ATTR

public static final String[] PAGE_ATTR

String array of RtfPage attributes

Constructor Details

RtfPage

RtfPage(RtfPageArea parent,
 Writer w,
 RtfAttributes attrs)
 throws IOException

RtfPage creates new page attributes with the parent container, the writer and the attributes

Throws:

IOException

Method Details

writeRtfContent

protected void writeRtfContent()
                        throws IOException

RtfPage writes the attributes the attributes contained in the string PAGE_ATTR, if not null

Overrides:

writeRtfContent in class RtfContainer

Throws:

IOException - for I/O problems

getAttributes

public RtfAttributes getAttributes()

RtfPage - attributes accessor

Returns:

attributes

okToWriteRtf

protected boolean okToWriteRtf()

RtfPage - is overwritten here because page attributes have no content only attributes. RtfContainer is defined not to write when empty. Therefore must make this true to print.

Overrides:

okToWriteRtf in class RtfContainer

Returns:

true