FOM 参照 > Formatting > References > fLeader interface
fLeader interface
This object sets up a leader.
LeaderFitModes enumeration
The possible methods for generating the leaders
The LeaderFitModes enumeration has the following constants of type int.
FITMODE_UL = 0
Use the traditional "ul" leader formatting.
FITMODE_PREFERLENGTH = 1
Prefer using the length leader properties to calculate the leader size, with the repeat properties as a fallback if not specified.
FITMODE_PREFERREPEAT = 2
Prefer using the repeat leader properties to calculate the leader size, with the length properties as a fallback if not specified.
LeaderAlign enumeration
The possible methods for aligning the leaders with the paragraph
The LeaderAlign 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
fitMode attribute
Which leader mode should be used. Possible values are in fLeader-LeaderFitModes.
fitMode
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
length attribute
The fixed amount of space allowed for the leader. If this length exceeds the space available on the current line, it shall be wrapped to the next line.
length
Access
read-write
Returns
fLength
maxLength attribute
The maximum length allowed for the leader.
maxLength
Access
read-write
Returns
fLength
maxRepeats attribute
The maximum number of times the text should be repeated for the leader.
maxRepeats
Access
read-write
Returns
int
minAfterBreak attribute
The minimum number of leader dots allowed on the next line after the leader has wrapped.
minAfterBreak
Access
read-write
Returns
int
minBeforeBreak attribute
The minimum number of leader dots allowed before the leader wraps to the next line.
minBeforeBreak
Access
read-write
Returns
int
minLength attribute
The minimum length allowed for the leader. If this length exceeds the space available on the current line, it shall be wrapped to the next line.
minLength
Access
read-write
Returns
fLength
minRepeats attribute
The minimum number of times the text should be repeated for the leader. If this exceeds the space available on the current line, it shall be wrapped to the next line.
minRepeats
Access
read-write
Returns
int
repeats attribute
The fixed number of times the text should be repeated. If this exceeds the space available on the current line, it shall be wrapped to the next line.
repeats
Access
read-write
Returns
int
text attribute
PI: tldrtxt
The text to use in the leader.
text
Access
read-write
Returns
String
fLeader method
Creates a new leader.
fLeader text align gap gapLeft gapRight
Parameters
String text
[optional] The text to use in the leader.
int align
[optional] Specifies the way in which the text leaders assigned to the paragraph are aligned.
fLength gap
[optional] The size of the gap between each leader.
fLength gapLeft
[optional] The size of the gap between the left of the leaders and the paragraph.
fLength gapRight
[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.
readResolve obj
Parameters
Object obj
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.
Parent topic 
References
Related information 
fLength interface
これは役に立ちましたか?