TextOperationEvent

Package	spark.events
Class	public class TextOperationEvent
Inheritance	TextOperationEvent Event Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

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

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		operation : FlowOperation The FlowOperation object representing the editing operation being performed on the text by the user.	TextOperationEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TextOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, operation:FlowOperation = null) Constructor.	TextOperationEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited 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.

Related API Elements

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

()

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.

TextOperationEvent - AS3 Flex

Classes x

operation