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

Class RtfPage


public class RtfPage
extends RtfContainer

Specifies rtf control words. Is the container for page attributes. Overrides okToWriteRtf.
Author:
Christopher Scott, scottc@westinghouse.com

Field Summary

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

Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

attrib, parent, writer

Method Summary

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 org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

addChild, getChildCount, getChildren, isEmpty, okToWriteRtf, setChildren, setOptions, toString, writeRtfContent

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

close, getRtfAttributes, isEmpty, newLine, okToWriteRtf, toString, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfContent, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Field Details

FOOTERY

public static final String FOOTERY
constant for footer position

HEADERY

public static final String HEADERY
constant for header position

ITAP

public static final String ITAP
constant for itap level

LANDSCAPE

public static final String LANDSCAPE
constant for landscape format

MARGIN_BOTTOM

public static final String MARGIN_BOTTOM
constant for bottom margin

MARGIN_LEFT

public static final String MARGIN_LEFT
constant for left margin

MARGIN_RIGHT

public static final String MARGIN_RIGHT
constant for right margin

MARGIN_TOP

public static final String MARGIN_TOP
constant for top margin

PAGE_ATTR

public static final String[] PAGE_ATTR
String array of RtfPage attributes

PAGE_HEIGHT

public static final String PAGE_HEIGHT
constant for page height

PAGE_WIDTH

public static final String PAGE_WIDTH
constant for page width

Method Details

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 interface RtfContainer
Returns:
true

writeRtfContent

protected void writeRtfContent()
            throws IOException
RtfPage writes the attributes the attributes contained in the string PAGE_ATTR, if not null
Overrides:
writeRtfContent in interface RtfContainer

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.