TextInput.enter

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX 2004.

Usage

Usage 1:

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

Usage 2:

on (enter) {
    //...
}

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 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, also called a handler, on 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 properties that contain information about the event. You can use these properties to write code that handles the event. Finally, you call the EventDispatcher.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, see EventDispatcher class.

Example

This example creates a listener for an enter event on a TextInput instance called my_ti. When the enter event occurs, if the user entered fewer than eight characters, the example displays: You must enter at least 8 characters. Otherwise, it displays Thanks!

You must first drag a TextInput component to the Stage and give it an instance name of my_ti; then add the following code to Frame 1.

/**
 Requires:
  - TextInput instance on Stage (instance name: my_ti)
*/

var my_ti:mx.controls.TextInput;

// Create listener object.
var tiListener:Object = new Object();
tiListener.handleEvent = function (evt_obj:Object){
 if (evt_obj.type == "enter"){
  if (my_ti.length < 8) {
   trace("You must enter at least 8 characters");
  } else {
   trace("Thanks");
  }
 }
}
// Add listener.
my_ti.addEventListener("enter", tiListener);

See also

EventDispatcher.addEventListener()