org.axsl.areaR
Interface LeaderArea

All Superinterfaces:

Area, AreaNode, GeneralInlineArea

public interface LeaderArea

extends GeneralInlineArea

Area containing a leader.

Method Summary

char[]	dotLeaderText() The text that should be written for the leader.
short	traitLeaderPattern() Returns the leader-pattern trait.
short	traitRuleStyle() Returns the style for this leader.
int	traitRuleThickness() Returns the thickness for this leader.

Methods inherited from interface org.axsl.areaR.GeneralInlineArea

baselineX, baselineY, getLineArea, getPrimaryFont, getSecondaryFont, letterSpacing, traitFontSize, traitOverlineScore, traitOverlineScoreColor, traitThroughScore, traitThroughScoreColor, traitUnderlineScore, traitUnderlineScoreColor

Methods inherited from interface org.axsl.areaR.Area

brBPD, brIPD, brOriginX, brOriginY, brPoints, crBPD, crIPD, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, getColor, getProgressionDimension, linkDestination, linkType, prOriginX, prOriginY, rrBPD, rrIPD, rrOriginX, rrOriginY, traitBorderAfterColor, traitBorderAfterWidth, traitBorderBeforeColor, traitBorderBeforeWidth, traitBorderEndColor, traitBorderEndWidth, traitBorderStartColor, traitBorderStartWidth, traitOverflow, traitScaling

Methods inherited from interface org.axsl.areaR.AreaNode

ancestorLineAreaOut, getAreaName, getChildren, getFontConsumer, getParentOut, render, traitColor, traitFontStyle, traitFontWeight, traitId, traitInternalDestination

Method Detail

traitLeaderPattern

public short traitLeaderPattern()

Returns the leader-pattern trait.

Returns:

The leader-pattern trait, one of Constants.FOVAL_SPACE, Constants.FOVAL_RULE, Constants.FOVAL_DOTS, or Constants.FOVAL_USE_CONTENT.

traitRuleThickness

public int traitRuleThickness()

Returns the thickness for this leader.

Returns:

The length, in millipoints, of the thickness of the rule.

traitRuleStyle

public short traitRuleStyle()

Returns the style for this leader.

Returns:

The rule style, one of Constants.FOVAL_NONE, Constants.FOVAL_DOTTED, Constants.FOVAL_DASHED, Constants.FOVAL_SOLID, Constants.FOVAL_DOUBLE, Constants.FOVAL_GROOVE, or Constants.FOVAL_RIDGE.

dotLeaderText

public char[] dotLeaderText()

The text that should be written for the leader.

Returns:

The text that should be written to make this dot leader, or null if there nothing to write.