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

Package | spark.events
Class | public class TextOperationEvent
Inheritance | TextOperationEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The TextOperationEvent class represents events that are dispatched when text content changes due to user operations such as inserting characters, backspacing, pasting, or changing text attributes.

This event is dispatched by subclasses of the SkinnableTextBase class. This includes RichEditableText and classes that use RichEditableText such as ComboBox and TextInput, as well as TextArea. Text controls that have no user interaction, such as RichText and Label, do not dispatch events of this type.

See also

spark.components.RichEditableText
spark.components.TextArea
spark.components.ComboBox
spark.components.TextInput
spark.components.supportClasses.SkinnableTextBase

Public Properties

| Property | Defined By
--- | --- | ---
|  | operation : FlowOperation The FlowOperation object representing the editing operation being performed on the text by the user. | TextOperationEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | TextOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, operation:FlowOperation = null) Constructor. | TextOperationEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = change [static] The TextOperationEvent.CHANGE constant defines the value of the type property of the event object for a change event. | TextOperationEvent
|  | CHANGING : String = changing [static] The TextOperationEvent.CHANGING constant defines the value of the type property of the event object for a changing event. | TextOperationEvent

Property Detail

operation | property

`public var operation:FlowOperation`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The FlowOperation object representing the editing operation being performed on the text by the user.

This might be an InsertTextOperation, a DeleteTextOperation, a SplitParagraphOperation, a CutOperation, a PasteOperation, an UndoOperation, or other subclass of FlowOperation.

See also

flashx.textLayout.operations.InsertTextOperation
flashx.textLayout.operations.DeleteTextOperation
flashx.textLayout.operations.SplitParagraphOperation
flashx.textLayout.operations.PasteOperation
flashx.textLayout.operations.CutOperation
flashx.textLayout.operations.UndoOperation
Constructor Detail

TextOperationEvent | () | Constructor

`public function TextOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, operation:FlowOperation = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `true`)`` — Specifies whether the behavior associated with the event can be prevented.
| `operation:FlowOperation` (default = `null`)`` — The FlowOperation object representing the editing operation being performed on the text by the user.

Constant Detail

CHANGE | Constant

`public static const CHANGE:String = change`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `TextOperationEvent.CHANGE` constant defines the value of the `type` property of the event object for a `change` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`operation` | The FlowOperation object describing the editing operation being performed on the text by the user.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

CHANGING | Constant |

`public static const CHANGING:String = changing`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The `TextOperationEvent.CHANGING` constant defines the value of the `type` property of the event object for a `changing` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`operation` | The FlowOperation object describing the editing operation being performed on the text by the user.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

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