Class RtfPageNumberCitation

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

public class RtfPageNumberCitation
extends RtfContainer

Page number citation container.

This work was authored by Christopher Scott (scottc@westinghouse.com) and Boris Pouderous (boris.pouderous@free.fr).

Field Summary

Fields

Modifier and Type	Field	Description
private String	id
static final String	RTF_FIELD	constant for field
static final String	RTF_FIELD_PAGEREF_MODEL	constant for field pageref model
static final String	RTF_FIELD_RESULT	constant for field result

Fields inherited from class RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfPageNumberCitation(RtfContainer parent, Writer w, String id)	Create an RTF page number citation as a child of given container with default attributes
RtfPageNumberCitation(RtfParagraph parent, Writer w, String id)	Create an RTF page number citation as a child of given paragraph, copying its attributes

Method Summary

Modifier and Type	Method	Description
boolean	isEmpty()
private boolean	isValid()	checks that the 'ref-id' attribute exists
protected void	writeRtfContent()	Write the 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_PAGEREF_MODEL

public static final String RTF_FIELD_PAGEREF_MODEL

constant for field pageref model

See Also:

• Constant Field Values

RTF_FIELD_RESULT

public static final String RTF_FIELD_RESULT

constant for field result

See Also:

• Constant Field Values

id

private String id

Constructor Details

RtfPageNumberCitation

RtfPageNumberCitation(RtfContainer parent,
 Writer w,
 String id)
               throws IOException

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

Throws:

IOException

RtfPageNumberCitation

RtfPageNumberCitation(RtfParagraph parent,
 Writer w,
 String id)
               throws IOException

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

Throws:

IOException

Method Details

writeRtfContent

protected void writeRtfContent()
                        throws IOException

Write the content

Overrides:

writeRtfContent in class RtfContainer

Throws:

IOException - for I/O problems

isValid

private boolean isValid()

checks that the 'ref-id' attribute exists

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class RtfContainer

Returns:

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