(Beta)
| 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 |
IMEEvent.IME_COMPOSITION and IMEEvent.IME_START_COMPOSITION.
Related API Elements
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
| 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 | ||
[override]
Creates a copy of the IMEEvent object and sets the value of each property to match that of the original. | IMEEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the IMEEvent object. | IMEEvent | ||
|
Returns the primitive value of the specified object. | Object | |
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):voidConstructor 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.
Parameterstype: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)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
text:String (default = "TextEvent.TEXT_INPUT event. Event listeners can access this information through the text property.
| |
imeClient:IIMEClient (default = null) |
Related API Elements
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.
ReturnsEvent — 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]
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
Related API Elements
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
Wed Nov 21 2018, 06:34 AM -08:00