Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
TruncationOptions

Package | flashx.textLayout.factory
Class | public final class TruncationOptions
Inheritance | TruncationOptions 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

| Property | Defined By
--- | --- | ---
|  | lineCountLimit : int The maximum number of lines to create. | TruncationOptions
|  | truncationIndicator : String A string used to indicate that content could not be fully displayed because of limits on the number of lines. | TruncationOptions
|  | truncationIndicatorFormat : ITextLayoutFormat The style applied to the truncation indicator string. | TruncationOptions

Public Methods

| Method | Defined By
--- | --- | ---
|  | TruncationOptions(truncationIndicator:String, lineCountLimit:int, truncationIndicatorFormat:ITextLayoutFormat = null) Creates a TruncationOptions object. | TruncationOptions

Public Constants

| Constant | Defined 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: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():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.

See also

truncationIndicator

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

lineCountLimit

Wed Nov 15 2017, 09:50 AM +01:00