FOM Reference > Formatting > References > fLeader interface
  
fLeader interface
This object sets up a leader.
LeaderMode enumeration
The possible methods for aligning the leaders with the paragraph
The LeaderMode enumeration has the following constants of type int.
LEFT = 0
Align leader characters from the left.
RIGHT = 1
Align leader characters from the right.
LEFT_IGNORE_MARGINS = 2
Align leaders from the left, but ignore paragraph margins and rules.
RIGHT_IGNORE_MARGINS = 3
Align leaders from the right, but ignore paragraph margins and rules.
LEFT_WITH_GAP = 4
Align leaders from the left hand edge of the leader itself with an optional left gap.
RIGHT_WITH_GAP = 5
Align leaders from the right hand edge of the leader itself with an optional right gap.
FLUSH_OUT = 6
Place as many whole leaders as possible, increasing the size of the gap between leaders to spread them out evenly.
FLUSH_IN = 7
Place as many whole leaders as possible, increasing the size of the left and right gaps to spread them out evenly.
align attribute
PI: tldrmode
Specifies the way in which the text leaders assigned to the paragraph are aligned.
align
Access
read-write
Returns
int
gap attribute
PI: tldrgap
The size of the gap between each leader.
gap
Access
read-write
Returns
fLength
gapLeft attribute
PI: tldrlgap
The size of the gap between the left of the leaders and the paragraph.
gapLeft
Access
read-write
Returns
fLength
gapRight attribute
PI: tldrrgap
The size of the gap between the right of the leaders and the paragraph.
gapRight
Access
read-write
Returns
fLength
text attribute
PI: tldrtxt
The text to use in the leader.
text
Access
read-write
Returns
String
fLeader method
Creates a new leader.
fLeadertextaligngapgapLeftgapRight
Parameters
Stringtext
[optional] The text to use in the leader.
intalign
[optional] Specifies the way in which the text leaders assigned to the paragraph are aligned.
fLengthgap
[optional] The size of the gap between each leader.
fLengthgapLeft
[optional] The size of the gap between the left of the leaders and the paragraph.
fLengthgapRight
[optional] The size of the gap between the right of the leaders and the paragraph.
Returns
fLeader. A new object of class fLeader
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fLeader. The object corresponding to the serialized representation.
toString method
Return the PI compatible string for the leader.
toString
Parameters
None
Returns
String. A PI compatible representation of this leader as a string.