flash.events

# IMEEvent - AS3

Package | flash.events
Class | public class IMEEvent
Inheritance | IMEEvent TextEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

An IMEEvent object is dispatched when the user enters text using an input method editor (IME). IMEs are generally used to enter text from languages that have ideographs instead of letters, such as Japanese, Chinese, and Korean. There are two IME events: `IMEEvent.IME_COMPOSITION` and `IMEEvent.IME_START_COMPOSITION`.

Related API Elements

flash.system.IME
flash.events.IMEEvent.IME_COMPOSITION
flash.events.IMEEvent.IME_START_COMPOSITION

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | imeClient : IIMEClient Specifies an object that implements the IMEClient interface. | IMEEvent
|  | target : Object [read-only] The event target. | Event
|  | text : String For a textInput event, the character or sequence of characters entered by the user. | TextEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | IMEEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", imeClient:IIMEClient = null) Creates an Event object with specific information relevant to IME events. | IMEEvent
|  | clone():Event [override] Creates a copy of the IMEEvent object and sets the value of each property to match that of the original. | IMEEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the IMEEvent object. | IMEEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | IME_COMPOSITION : String = "imeComposition" [static] Defines the value of the type property of an imeComposition event object. | IMEEvent
|  | IME_START_COMPOSITION : String = "imeStartComposition" [static] To handle IME text input, the receiver must set the imeClient field of the event to an object that implements the IIMEClient interface. | IMEEvent

Property Detail

### imeClient

property

`imeClient:IIMEClient`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 10.1

Specifies an object that implements the IMEClient interface. Components based on the flash.text.engine package must implement this interface to support editing text inline using an IME.

Implementation
`public function get imeClient():IIMEClient`
`public function set imeClient(value:IIMEClient):void`
Constructor Detail

### IMEEvent

()
Constructor

`public function IMEEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", imeClient:IIMEClient = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Creates an Event object with specific information relevant to IME events. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There is only one IME event: `IMEEvent.IME_COMPOSITION`.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited `bubbles` property.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.
| `text:String` (default = "``")`` — The reading string from the IME. This is the initial string as typed by the user, before selection of any candidates. The final composition string is delivered to the object with keyboard focus in a `TextEvent.TEXT_INPUT` event. Event listeners can access this information through the `text` property.
| `imeClient:IIMEClient` (default = `null`)`` — A set of callbacks used by the text engine to communicate with the IME. Useful if your code has its own text engine and is rendering lines of text itself, rather than using TextField objects or the TextLayoutFramework.

Related API Elements

flash.system.IME
flash.events.IMEEvent.IME_COMPOSITION
flash.events.IMEEvent.IME_START_COMPOSITION
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Creates a copy of the IMEEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new IMEEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Returns a string that contains all the properties of the IMEEvent object. The string is in the following format:

`[IMEEvent type=value bubbles=value cancelable=value text=value]`

Returns

| `String` — A string that contains all the properties of the IMEEvent object.

Constant Detail

### IME_COMPOSITION

Constant

`public static const IME_COMPOSITION:String = "imeComposition"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Defines the value of the `type` property of an `imeComposition` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`target` | The IME object.

More examples

Using the IME class

Related API Elements

flash.system.IME.imeComposition

### IME_START_COMPOSITION

Constant

`public static const IME_START_COMPOSITION:String = "imeStartComposition"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 10.1

To handle IME text input, the receiver must set the `imeClient` field of the event to an object that implements the IIMEClient interface. If `imeClient` is unset, the runtime uses out-of-line IME composition instead, and sends the final composition as a TEXT_INPUT event.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`target` | The IME object.

Related API Elements

flash.system.IME.imeComposition

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00