The TruncationOptions class specifies options for limiting the number of lines of text
created by a text line factory and for indicating when lines have been left out.
The style applied to the truncation indicator string.
Implementation public function get truncationIndicatorFormat():ITextLayoutFormat public function set truncationIndicatorFormat(value:ITextLayoutFormat):void
Constructor Detail
TruncationOptions
()
Constructor
public function TruncationOptions(truncationIndicator:String, lineCountLimit:int, truncationIndicatorFormat:ITextLayoutFormat = null)
Language Version :
ActionScript 3.0
Runtime Versions :
Flash Player 10, AIR 1.5
Creates a TruncationOptions object.
Parameters
truncationIndicator:String (default = NaN) — the string used to indicate that text has been truncated.
It appears at the end of the composed text. The default value is the horizontal ellipsis (U+2026).
lineCountLimit:int (default = NaN) — specifies a truncation criterion in the form of the maximum
number of lines allowed. The default value of NO_LINE_COUNT_LIMIT
indicates that there is no line count limit.
truncationIndicatorFormat:ITextLayoutFormat (default = null) — specifies the format for the truncation indicator.
A null format (the default value) specifies that the truncation indicator assume
the format of content just before the truncation point. The TextLineFactory
methods that take a simple string as input also ignore this parameter and implement
the default behavior.
Constant Detail
HORIZONTAL_ELLIPSIS
Constant
public static const HORIZONTAL_ELLIPSIS:String = …
Language Version :
ActionScript 3.0
Runtime Versions :
Flash Player 10, AIR 1.5
Defines the truncationIndicator property value, \u2026, that represents a horizontal ellipsis.
Object