Class RtfLeader

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

public class RtfLeader
extends RtfContainer

Generates the leader in RTF.

Field Summary

Fields

Modifier and Type	Field	Description
private RtfAttributes	attrs
static final String	LEADER_DOTTED	Dotted underline
static final String	LEADER_EQUAL	Double underline
static final String	LEADER_EXPAND	Negative expansion
static final String	LEADER_HYPHENS	Heavy wave underline
static final String	LEADER_IGNORE_STYLE	Resets to default properties
static final String	LEADER_MIDDLEDOTTED	Dashed underline
static final String	LEADER_PATTERN_WIDTH	Expansion or compression of the space between characters in twips
static final String	LEADER_RULE_THICKNESS	Font size determines rule thickness
static final int	LEADER_STANDARD_WIDTH	Standard leader width
static final String	LEADER_TAB_DOTTED	Leader dots
static final String	LEADER_TAB_EQUAL	Leader equal sign
static final String	LEADER_TAB_HYPHENS	Leader hyphens
static final String	LEADER_TAB_MIDDLEDOTTED	Leader middle dots
static final String	LEADER_TAB_RIGHT	Right-aligned tab
static final String	LEADER_TAB_THICK	Leader thick line
static final String	LEADER_TAB_UNDERLINE	Leader underline
static final String	LEADER_TAB_VALUE	Tab
static final String	LEADER_TAB_WIDTH	Tab width
static final String	LEADER_TABLEAD	Private attribute: tab style
static final String	LEADER_THICK	Thick underline
static final String	LEADER_UNDERLINE	Dash-dot-dotted underline
static final String	LEADER_UP	Move up 4 half-points
static final String	LEADER_USETAB	Private attribute: tab usage indicator
static final String	LEADER_WIDTH	Private attribute: leader width
static final String	LEADER_ZERO_WIDTH	Zero-width break opportunity

Fields inherited from class RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfLeader(RtfContainer parent, Writer w, RtfAttributes attrs)

Method Summary

Modifier and Type	Method	Description
boolean	isEmpty()
protected void	writeRtfContent()	write RTF code of all our children

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

attrs

private RtfAttributes attrs

LEADER_TABLEAD

public static final String LEADER_TABLEAD

Private attribute: tab style

See Also:

• Constant Field Values

LEADER_USETAB

public static final String LEADER_USETAB

Private attribute: tab usage indicator

See Also:

• Constant Field Values

LEADER_WIDTH

public static final String LEADER_WIDTH

Private attribute: leader width

See Also:

• Constant Field Values

LEADER_DOTTED

public static final String LEADER_DOTTED

Dotted underline

See Also:

• Constant Field Values

LEADER_MIDDLEDOTTED

public static final String LEADER_MIDDLEDOTTED

Dashed underline

See Also:

• Constant Field Values

LEADER_HYPHENS

public static final String LEADER_HYPHENS

Heavy wave underline

See Also:

• Constant Field Values

LEADER_UNDERLINE

public static final String LEADER_UNDERLINE

Dash-dot-dotted underline

See Also:

• Constant Field Values

LEADER_EQUAL

public static final String LEADER_EQUAL

Double underline

See Also:

• Constant Field Values

LEADER_THICK

public static final String LEADER_THICK

Thick underline

See Also:

• Constant Field Values

LEADER_TAB_DOTTED

public static final String LEADER_TAB_DOTTED

Leader dots

See Also:

• Constant Field Values

LEADER_TAB_MIDDLEDOTTED

public static final String LEADER_TAB_MIDDLEDOTTED

Leader middle dots

See Also:

• Constant Field Values

LEADER_TAB_HYPHENS

public static final String LEADER_TAB_HYPHENS

Leader hyphens

See Also:

• Constant Field Values

LEADER_TAB_UNDERLINE

public static final String LEADER_TAB_UNDERLINE

Leader underline

See Also:

• Constant Field Values

LEADER_TAB_EQUAL

public static final String LEADER_TAB_EQUAL

Leader equal sign

See Also:

• Constant Field Values

LEADER_TAB_THICK

public static final String LEADER_TAB_THICK

Leader thick line

See Also:

• Constant Field Values

LEADER_IGNORE_STYLE

public static final String LEADER_IGNORE_STYLE

Resets to default properties

See Also:

• Constant Field Values

LEADER_RULE_THICKNESS

public static final String LEADER_RULE_THICKNESS

Font size determines rule thickness

See Also:

• Constant Field Values

LEADER_PATTERN_WIDTH

public static final String LEADER_PATTERN_WIDTH

Expansion or compression of the space between characters in twips

See Also:

• Constant Field Values

LEADER_ZERO_WIDTH

public static final String LEADER_ZERO_WIDTH

Zero-width break opportunity

See Also:

• Constant Field Values

LEADER_STANDARD_WIDTH

public static final int LEADER_STANDARD_WIDTH

Standard leader width

See Also:

• Constant Field Values

LEADER_UP

public static final String LEADER_UP

Move up 4 half-points

See Also:

• Constant Field Values

LEADER_EXPAND

public static final String LEADER_EXPAND

Negative expansion

See Also:

• Constant Field Values

LEADER_TAB_VALUE

public static final String LEADER_TAB_VALUE

Tab

See Also:

• Constant Field Values

LEADER_TAB_RIGHT

public static final String LEADER_TAB_RIGHT

Right-aligned tab

See Also:

• Constant Field Values

LEADER_TAB_WIDTH

public static final String LEADER_TAB_WIDTH

Tab width

See Also:

• Constant Field Values

Constructor Details

RtfLeader

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

Throws:

IOException

Method Details

writeRtfContent

protected void writeRtfContent()
                        throws IOException

write RTF code of all our children

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, i.e. (for RtfContainer) true if it has no children where isEmpty() is false