mx.automation.delegates.TextFieldAutomationHelper - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.automation.delegates
Class	public class TextFieldAutomationHelper
Inheritance	TextFieldAutomationHelper Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Utility class that facilitates replay of text input and selection.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TextFieldAutomationHelper(owner:IEventDispatcher, replayer:IAutomationObject, textField:mx.core:IUITextField) Constructor.	TextFieldAutomationHelper
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean 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.	TextFieldAutomationHelper
		replayAutomatableEvent(event:Event):Boolean Replays TypeTextEvents and TypeEvents.	TextFieldAutomationHelper
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Constructor Detail

TextFieldAutomationHelper

()

Constructor

public function TextFieldAutomationHelper(owner:IEventDispatcher, replayer:IAutomationObject, textField:mx.core:IUITextField)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

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.

	`textField:mx.core:IUITextField` — 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 3

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 3

Runtime Versions:

Flash Player 9, AIR 1.1

Replays TypeTextEvents and TypeEvents. TypeTextEvents are replayed by calling replaceText on the underlying text field. TypeEvents are replayed depending on the character typed. Both also dispatch 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). Ideally, the code would just dispatch the original keystrokes, but the Flash Player TextField ignores the events we are sending it.

Parameters

event:Event — Event to replay.

Returns

Boolean — If true, replay the event.