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

SparkRichEditableTextAutomationHelper  - AS3 Flex

Packagespark.automation.delegates
Classpublic class SparkRichEditableTextAutomationHelper
InheritanceSparkRichEditableTextAutomationHelper Inheritance Object

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

Utility class that facilitates replay of text input and selection.

Learn more



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
Constructor.
SparkRichEditableTextAutomationHelper
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
recordAutomatableEvent(interaction:Event, cacheable:Boolean = false):void
Records the user interaction with the text control.
SparkRichEditableTextAutomationHelper
  
Replays TextEvens, Selection Event, and type events.
SparkRichEditableTextAutomationHelper
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Constructor Detail

SparkRichEditableTextAutomationHelper

()Constructor
public function SparkRichEditableTextAutomationHelper(owner:IEventDispatcher, replayer:IAutomationObject, richEditableText:spark.components:RichEditableText)

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

Constructor.

Parameters
owner:IEventDispatcher — The UIComponent that is using the TextField. For example, if a TextArea is using the TextField, then the TextArea is the owner.
 
replayer:IAutomationObject — The IAutomationObject of the component.
 
richEditableText:spark.components:RichEditableText — The TextField object inside the component.
Method Detail

recordAutomatableEvent

()method
public function recordAutomatableEvent(interaction:Event, cacheable:Boolean = false):void

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

Records the user interaction with the text control.

Parameters

interaction:Event — The event to record.
 
cacheable:Boolean (default = false) — Contains true if this is a cacheable event, and false if not.

replayAutomatableEvent

()method 
public function replayAutomatableEvent(event:Event):Boolean

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

Replays TextEvens, Selection Event, and type events. TypeEvents and Text events are replayed depending on the character typed. Both dispatches the origin keystrokes. This is necessary to mimic the original behavior, in case any components are listening to keystroke events (for example, DataGrid listens to itemRenderer events, or if a custom component is trying to do key masking). In Halo, the text events were changing the contents using the text related methods as the flash player was ignoring the key evens. In Gumbo this is not the case, so for the text and type events, we need only to send the key strokes. dispatch the original keystrokes, but the Flash Player richEditableText ignores the events we are sending it.

Parameters

event:Event — Event to replay.

Returns
Boolean — If true, replay the event.