org.apache.fop.area.inline

Class Leader

Implemented Interfaces:
Serializable

public class Leader
extends InlineArea

This is a leader inline area. This class is only used for leader with leader-pattern of rule.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.area.inline.InlineArea

InlineArea.InlineAdjustingInfo

Field Summary

Fields inherited from class org.apache.fop.area.inline.InlineArea

adjustingInfo, offset

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

Leader()
Create a new leader area.

Method Summary

int
getRuleStyle()
Get the rule style of this leader.
String
getRuleStyleAsString()
int
getRuleThickness()
Get the rule thickness of the rule in miilipoints.
void
setRuleStyle(String style)
Set the rule style of this leader area.
void
setRuleStyle(int style)
Set the rule style of this leader area.
void
setRuleThickness(int rt)
Set the rule thickness of the rule in miilipoints.

Methods inherited from class org.apache.fop.area.inline.InlineArea

addChildArea, applyVariationFactor, getAdjustingInfo, getOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustment, setOffset, setParentArea

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Constructor Details

Leader

public Leader()
Create a new leader area.

Method Details

getRuleStyle

public int getRuleStyle()
Get the rule style of this leader.
Returns:
the rule style

getRuleStyleAsString

public String getRuleStyleAsString()
Returns:
the rule style as string

getRuleThickness

public int getRuleThickness()
Get the rule thickness of the rule in miilipoints.
Returns:
the rule thickness in millipoints

setRuleStyle

public void setRuleStyle(String style)
Set the rule style of this leader area.
Parameters:
style - the rule style for the leader area (XSL enum values)

setRuleStyle

public void setRuleStyle(int style)
Set the rule style of this leader area.
Parameters:
style - the rule style for the leader line

setRuleThickness

public void setRuleThickness(int rt)
Set the rule thickness of the rule in miilipoints.
Parameters:
rt - the rule thickness in millipoints

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