ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
spark.events 

TextOperationEvent  - AS3 Flex
Packagespark.events
Classpublic class TextOperationEvent
InheritanceTextOperationEvent Inheritance Event Inheritance 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
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : 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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TextOperationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, operation:FlowOperation = null)
Constructor.
TextOperationEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe 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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe 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.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe 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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy