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

TextSelectionEvent  - AS3 Flex
Packagemx.automation.events
Classpublic class TextSelectionEvent
InheritanceTextSelectionEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The TextSelectionEvent class lets you track selection within a text field.

Learn more

Instrumenting events

Public Properties
 PropertyDefined By
  beginIndex : int
Index at which selection starts.
TextSelectionEvent
 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
  endIndex : int
Index at which selection ends.
TextSelectionEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TextSelectionEvent(type:String = "textSelectionChange", bubbles:Boolean = false, cancelable:Boolean = false, beginIndex:int = -1, endIndex:int = -1)
Constructor.
TextSelectionEvent
 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
  TEXT_SELECTION_CHANGE : String = "textSelectionChange"
[static] The TextSelectionEvent.TEXT_SELECTION_CHANGE constant defines the value of the type property of the event object for a textSelectionChange event.
TextSelectionEvent
Property Detail

beginIndex

property
public var beginIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Index at which selection starts.

endIndex

property 
public var endIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Index at which selection ends.

Constructor Detail

TextSelectionEvent

()Constructor
public function TextSelectionEvent(type:String = "textSelectionChange", bubbles:Boolean = false, cancelable:Boolean = false, beginIndex:int = -1, endIndex:int = -1)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String (default = "textSelectionChange") — 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 = false) — Specifies whether the behavior associated with the event can be prevented.
 
beginIndex:int (default = -1) — Index at which selection starts.
 
endIndex:int (default = -1) — Index at which selection ends.
Constant Detail

TEXT_SELECTION_CHANGE

Constant
public static const TEXT_SELECTION_CHANGE:String = "textSelectionChange"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The TextSelectionEvent.TEXT_SELECTION_CHANGE constant defines the value of the type property of the event object for a textSelectionChange event.

The properties of the event object have the following values:

PropertyValue
beginIndexIndex at which selection starts.
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.
endIndexIndex at which selection ends.
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