TextInput.enter

Availability

Flash Player 6.0.79.

Edition

Flash MX 2004.

Usage

Usage 1:

on(enter){
  ...
}

Usage 2:

listenerObject = new Object();
listenerObject.enter = function(eventObject){
  ...
}
textInputInstance.addEventListener("enter", listenerObject)

Description

Event; notifies listeners that the enter key has been pressed.

The first usage example uses an on() handler and must be attached directly to a TextInput component instance. The keyword this, used inside an on() handler attached to a component, refers to the component instance. For example, the following code, attached to the instance myTextInput, sends "_level0.myTextInput" to the Output panel:

on(enter){
  trace(this);
}

The second usage example uses a dispatcher/listener event model. A component instance (textInputInstance) dispatches an event (in this case, enter) and the event is handled by a function attached to a listener object (listenerObject) that you create. You define a method with the same name as the event on the listener object; the method is called when the event is triggered. When the event is triggered, it automatically passes an event object (eventObject) to the listener object method. Each event object has a set of properties that contains information about the event. You can use these properties to write code that handles the event. Finally, you call the UIEventDispatcher.addEventListener() method on the component instance that broadcasts the event to register the listener with the instance. When the instance dispatches the event, the listener is called.

For more information about event objects, see Event Objects.

Example

This example sets a flag in the application that indicates if contents in the TextInput field have changed:

form.enter = function(eventObj){
  // eventObj.target is the component which generated the enter event,
  // i.e., the Input component.
  myFormChanged.visible = true;  
// set a change indicator if the user presses enter;
}
myInput.addEventListener("enter", form);

See also

UIEventDispatcher.addEventListener()