Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
TextLayoutEvent

Package | flashx.textLayout.events
Class | public class TextLayoutEvent
Inheritance | TextLayoutEvent flash.events.Event
Subclasses | ScrollEvent

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

A TextLayoutEvent instance represents an event, such as the `TextLayoutEvent.SCROLL` event, that does not require custom properties.

A scroll event is represented by a TextLayoutEvent instance with its `type` property set to `TextLayoutEvent.SCROLL`. A class specifically for scroll events is not necessary because there are no custom properties for a scroll event, as there are for the other events that have specific event classes. If a new text layout event is needed, and the event does not require custom properties, the new event will also be represented by a TextLayoutEvent object, but with its `type` property set to a new static constant.

Public Methods

| Method | Defined By
--- | --- | ---
|  | TextLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) The TextLayoutEvent class represents the event object passed to the event listener for many Text Layout events. | TextLayoutEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | SCROLL : String = scroll [static] The TextLayoutEvent.SCROLL constant defines the value of the type property of the event object for a scroll event. | TextLayoutEvent

Constructor Detail

TextLayoutEvent | () | Constructor

`public function TextLayoutEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The TextLayoutEvent class represents the event object passed to the event listener for many Text Layout events.

Parameters

| `type:String`
| `bubbles:Boolean` (default = `false`)``
| `cancelable:Boolean` (default = `false`)``

Constant Detail

SCROLL | Constant

`public static const SCROLL:String = scroll`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The `TextLayoutEvent.SCROLL` constant defines the value of the `type` property of the event object for a `scroll` event.

Sun Mar 5 2017, 03:42 PM +11:00