Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flashx.textLayout.factory 
TruncationOptions 
Packageflashx.textLayout.factory
Classpublic final class TruncationOptions
InheritanceTruncationOptions Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

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.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  lineCountLimit : int
The maximum number of lines to create.
TruncationOptions
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  truncationIndicator : String
A string used to indicate that content could not be fully displayed because of limits on the number of lines.
TruncationOptions
  truncationIndicatorFormat : flashx.textLayout.formats:ITextLayoutFormat
The style applied to the truncation indicator string.
TruncationOptions
Public Methods
 MethodDefined By
  
TruncationOptions(truncationIndicator:String, lineCountLimit:int, truncationIndicatorFormat:flashx.textLayout.formats:ITextLayoutFormat = null)
Creates a TruncationOptions object.
TruncationOptions
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  HORIZONTAL_ELLIPSIS : String = "…"
[static] Defines the truncationIndicator property value, \u2026, that represents a horizontal ellipsis.
TruncationOptions
  NO_LINE_COUNT_LIMIT : int = -1
[static] Defines the lineCountLimit property value, -1, that represents no limit.
TruncationOptions
Property Detail

lineCountLimit

property
lineCountLimit:int

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The maximum number of lines to create.



Implementation
    public function get lineCountLimit():int
    public function set lineCountLimit(value:int):void

truncationIndicator

property 
truncationIndicator:String

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

A string used to indicate that content could not be fully displayed because of limits on the number of lines.



Implementation
    public function get truncationIndicator():String
    public function set truncationIndicator(value:String):void

truncationIndicatorFormat

property 
truncationIndicatorFormat:flashx.textLayout.formats:ITextLayoutFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The style applied to the truncation indicator string.



Implementation
    public function get truncationIndicatorFormat():flashx.textLayout.formats:ITextLayoutFormat
    public function set truncationIndicatorFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void
Constructor Detail

TruncationOptions

()Constructor
public function TruncationOptions(truncationIndicator:String, lineCountLimit:int, truncationIndicatorFormat:flashx.textLayout.formats: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:flashx.textLayout.formats: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.

See also

NO_LINE_COUNT_LIMIT

Constant 
public static const NO_LINE_COUNT_LIMIT:int = -1

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Defines the lineCountLimit property value, -1, that represents no limit.

See also