IME Support

This section describes extensions for input method editor (IME) support.

disableIME property

disableIME:Boolean [read-write]

Scaleform version: 2.1.50

If set to true, prevents IME from being activated in this text field.

The default value is false.

getIMECompositionStringStyle () method

public function getIMECompositionStringStyle(categoryName:String): Object

Scaleform version: 2.1.50

Returns the color settings descriptor object for the specified category of IME color settings. See setIMECompositionStringStyle for a detailed description of the categoryName and the descriptor object.

Parameters
categoryName:String – Category of IME color settings (see setIMECompositionStringStyle).

Returns
Object - The descriptor of color settings for the category (see setIMECompositionStringStyle).

See also:

setIMECompositionStringStyle
disableIME

setIMECompositionStringStyle () method

public function setIMECompositionStringStyle(categoryName:String,
styleDescriptor:Object): Number

Scaleform version: 2.1.50

Sets the style to the appropriate category of IME color settings. The categoryName parameter may contain the following values: compositionSegment – sets color settings for the whole composition string; clauseSegment – sets color settings for clause segment; convertedSegment – sets color settings for converted text segment; phraseLengthAdj – sets color settings for phrase length adjustment; lowConfSegment – sets color settings for low-confidence characters.

The styleDescriptor is an Object instance with the following optional members set:

textColor : Number The color of text.

backgroundColor : Number The background color.

underlineColor : Number The color of underline.

underlineStyle : String The style of underline. Valid values:

single
thick
dotted
ditheredSingle
ditheredThick

All colors are specified in the following format: 0xRRGGBB, in which RR is the hexadecimal representation of the red component [0..255], BB is the hexadecimal representation of the blue component [0..255] and GG is the hexadecimal representation of the green component [0..255].

Parameters
categoryName:String – Category of IME color settings (see description).

styleDescriptor:Object – A color setting descriptor object (see description).

See also:

getIMECompositionStringStyle
disableIME