IME - Adobe ActionScript® 3 (AS3 ) API 参考

包	flash.system
类	public final class IME
继承	IME EventDispatcher Object

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

使用 IME 类，您可以在客户端计算机上运行的 Flash 运行时应用程序中直接对操作系统的输入法编辑器 (IME) 进行操作。可以确定是否安装了 IME、当前是否启用了 IME 以及启用了哪个 IME。您可以在应用程序中禁用或启用 IME，并且可以执行其他受限制的函数，具体取决于操作系统。

AIR 配置文件支持：桌面操作系统支持此功能，但所有移动设备均不支持此功能。 AIR for TV 设备也不支持此功能。您可以使用 IME.isSupported 属性在运行时测试是否受支持。有关在多个配置文件之间支持 API 的详细信息，请参阅 AIR 配置文件支持。

利用 IME，用户可键入多字节语言（例如，中文、日语和韩语）的非 ASCII 文本字符。有关使用 IME 的详细信息，请参阅要为其开发应用程序的操作系统的文档。要获取其他资源，请参阅以下网站：

如果用户计算机上 IME 未处于活动状态，则对 IME 方法或属性（除 Capabilities.hasIME 之外）的调用将会失败。一旦手动激活 IME，随后对 IME 方法和属性的 ActionScript 调用即会正常运行。例如，如果使用日语 IME，则必须在调用任何 IME 方法或属性之前将它激活。

下表显示了此类适用的平台范围：

功能	Windows	Mac OSX	Linux
确定是否已安装 IME：`Capabilities.hasIME`	是	是	是
将 IME 设置为启用或禁用状态：`IME.enabled`	是	是	是
查明是启用 IME 还是禁用 IME：`IME.enabled`	是	是	是
获取或设置 IME 转换模式：`IME.conversionMode`	是	是**	无
向 IME 发送要转换的字符串：`IME.setCompositionString()`	是 *	无	无
在转换之前从 IME 获取原始字符串：`System.ime.addEventListener()`	是 *	无	无
将转换请求发送到 IME：`IME.doConversion()`	是 *	无	无

* 并非所有 Windows IME 都支持上述全部操作。唯一支持全部操作的 IME 是日语 IME。

** 在 Macintosh 上，只有日语 IME 支持这些方法，第三方 IME 不支持这些方法。

此类的 ActionScript 3.0 版本不支持 Macintosh Classic。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		conversionMode : String [静态] 当前 IME 的转换模式。	IME
		enabled : Boolean [静态] 表示系统 IME 已启用 (true) 还是已禁用 (false)。	IME
		isSupported : Boolean [静态] [只读] 如果 IME 类在当前平台上可用，则 isSupported 属性设置为 true，否则，设置为 false。	IME

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		compositionAbandoned():void [静态] 导致运行时放弃任何正在进行的合成。	IME
		compositionSelectionChanged(start:int, end:int):void [静态] 在合成内的选区已更新（通过交互方式或编程方式）后调用此方法。	IME
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		doConversion():void [静态] 表示 IME 为当前复合字符串选择第一个候选项。	IME
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setCompositionString(composition:String):void [静态] 设置 IME 复合字符串。	IME
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
imeComposition	当用户完成输入法编辑器 (IME) 的输入且读取字符串可用时进行调度。	IME

属性详细信息

conversionMode

属性

conversionMode:String

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

当前 IME 的转换模式。可能的值为表示转换模式的 IME 模式字符串常量：

ALPHANUMERIC_FULL
ALPHANUMERIC_HALF
CHINESE
JAPANESE_HIRAGANA
JAPANESE_KATAKANA_FULL
JAPANESE_KATAKANA_HALF
KOREAN
UNKNOWN（只读值；此值不能设置）

实现
public static function get conversionMode():String
public static function set conversionMode(value:String):void

引发

Error — 设置尝试未成功。

enabled

属性

enabled:Boolean

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

表示系统 IME 已启用 (true) 还是已禁用 (false)。启用的 IME 执行多字节输入；禁用的 IME 执行字母数字输入。

实现
public static function get enabled():Boolean
public static function set enabled(value:Boolean):void

引发

Error — 设置尝试未成功。

isSupported

属性

isSupported:Boolean [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10.1, AIR 2

如果 IME 类在当前平台上可用，则 isSupported 属性设置为 true，否则，设置为 false。

实现
public static function get isSupported():Boolean

方法详细信息

compositionAbandoned

()

方法

public static function compositionAbandoned():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10.1, AIR 2

导致运行时放弃任何正在进行的合成。当用户单击合成区域外部或当破坏或重置具有焦点的交互式对象时，调用此方法。运行时通过在客户端调用 confirmComposition() 确认合成。运行时还重置 IME 以通知操作系统已放弃合成。

compositionSelectionChanged

()

方法

public static function compositionSelectionChanged(start:int, end:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10.1, AIR 2

在合成内的选区已更新（通过交互方式或编程方式）后调用此方法。

参数

	`start:int` — 指定选区开始的偏移（字节数）。

	`end:int` — 指定选区结尾的偏移（字节数）。

doConversion

()

方法

public static function doConversion():void

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

表示 IME 为当前复合字符串选择第一个候选项。

引发

Error — 调用未成功。

setCompositionString

()

方法

public static function setCompositionString(composition:String):void

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

设置 IME 复合字符串。设置了此字符串后，用户就可以在将结果提交到当前具有焦点的文本字段之前选择 IME 候选项。

如果不存在具有焦点的文本字段，则此方法将会失败并引发错误。

参数

composition:String — 要发送到 IME 的字符串。

引发

Error — 调用未成功。

事件详细信息

imeComposition

事件

事件对象类型: flash.events.IMEEvent
属性 IMEEvent.type = flash.events.IMEEvent.IME_COMPOSITION

语言版本:

ActionScript 3.0

运行时版本:

AIR 1.0, Flash Player 9

当用户完成输入法编辑器 (IME) 的输入且读取字符串可用时进行调度。使用 IME 进行输入的文本通常来自使用表意文字而非字母的语言，如日语、中文和韩语。

定义 imeComposition 事件对象的 type 属性值。

此事件具有以下属性：

属性	值
`bubbles`	`false`
`cancelable`	`false`；没有要取消的默认行为。
`currentTarget`	当前正在使用某个事件侦听器处理 Event 对象的对象。
`target`	IME 对象。

法律声明 | 在线隐私策略

IME - AS3

包x

语言元素

附录

包 flash.system

conversionMode

enabled

isSupported

compositionAbandoned

compositionSelectionChanged

doConversion

setCompositionString

imeComposition