flash.text.imeIIMEClient Interface for IME (input method editor) clients. Interface for IME (input method editor) clients. Components based on the flash.text.engine package must implement this interface to support editing text inline using an IME. This interface is not used with TextField objects. TextLayoutFramework (TLF) uses this interface to support inline IME, so clients using TLF do not need to implement this interface.

To support inline IME, set the imeClient property of an ImeEvent.IME_START_COMPOSITION event to an object which implements this interface.

flash.text.ime.CompositionAttributeRangeflash.events.ImeEvent:imeClienttextInput Dispatched when the user enters text.flash.events.TextEvent.TEXT_INPUTflash.TextEvent.TEXT_INPUT Dispatched when the user enters text. For IME (input method editor) clients, the receiver should insert the string contained in the event object's text property at the current insertion point. imeStartComposition Dispatched when the user begins to use an IME (input method editor).flash.events.IMEEvent.IME_START_COMPOSITIONflash.IMEEvent.IME_START_COMPOSITION Dispatched when the user begins to use an IME (input method editor). confirmComposition Use this callback to end the inline editing session and confirm the text.textnull the final state of the text in the inline session (the text that got confirmed). preserveSelectionfalse when true, you should not reset the current selection to the end of the confirmed text. Use this callback to end the inline editing session and confirm the text. getTextBounds This callback is used by the IME to query the bounding box of the text being edited with the IME client.the bounding box of the specified range of text, or null if either or both of the indexes are invalid. The same value should be returned independant of whether startIndex is greater or less than endIndex. startIndexan integer that specifies the starting location of the range of text for which you need to measure the bounding box. endIndexOptional; an integer that specifies the ending location of the range of text for which you need to measure the bounding box. This callback is used by the IME to query the bounding box of the text being edited with the IME client. Use this method to place the candidate window and set the mouse cursor in the IME client when the mouse is over the text field or other component that supports IME. getTextInRange Gets the specified range of text from the component.The requested text, or null if no text is available in the requested range or if either or both of the indexes are invalid. The same value should be returned independant of whether startIndex is greater or less than endIndex. startIndexan integer that specifies the starting location of the range of text to be retrieved. endIndexan integer that specifies the ending location of the range of text to be retrieved. Gets the specified range of text from the component. This method is called during IME reconversion. selectRange Sets the range of selected text in the component.anchorIndexThe zero-based index value of the character at the anchor end of the selection activeIndexThe zero-based index value of the character at the active end of the selection. Sets the range of selected text in the component. If either of the arguments is out of bounds the selection should not be changed. updateComposition Callback for updating the contents of the inline editing session.text contains the text of the inline edit session from the IME attributes contains an array of composition clauses with adornment info compositionStartIndex start of the inline session relative to the start of the text object compositionEndIndex end of the inline session relative to the start of the text object Callback for updating the contents of the inline editing session. This gets called whenever the text being edited with the IME has changed and its contents are used by the client to redraw the entire inline edit session. compositionEndIndex The zero-based character index value of the end of the current edit session text (i.e. The zero-based character index value of the end of the current edit session text (i.e. all text in the inline session that is still not yet confirmed to the document). compositionStartIndex The zero-based character index value of the start of the current edit session text (i.e. The zero-based character index value of the start of the current edit session text (i.e. all text in the inline session that is still not yet confirmed to the document). selectionActiveIndex The zero-based character index value of the last character in the current selection. The zero-based character index value of the last character in the current selection. selectionAnchorIndex The zero-based character index value of the first character in the current selection. The zero-based character index value of the first character in the current selection. verticalTextLayout Indicates whether the text in the component is vertical or not. Indicates whether the text in the component is vertical or not. This will affect the positioning of the candidate window (beside vertical text, below horizontal text). CompositionAttributeRange The CompositionAttributeRange class represents a range of composition attributes for use with IME events.Object The CompositionAttributeRange class represents a range of composition attributes for use with IME events. For example, when editing text in the IME, the text is divided by the IME into composition ranges. These composition ranges are flagged as selected (i.e. currently being lengthened, shortened, or edited), and/or converted (i.e. they have made one pass through the IME dictionary lookup already).

By convention, the client should adorn these composition ranges with underlining or hiliting according to the flags.

For example:

!converted = thick gray underline (raw text) !selected && converted = thin black underline selected && converted = thick black underline CompositionAttributeRange Creates a CompositionAttributeRange object.relativeStart The zero based index of the first character included in the character range. relativeEnd The zero based index of the last character included in the character range. selected The selected flag converted The converted flag Constructor for CompositionAttributeRange objects. Creates a CompositionAttributeRange object. converted The converted flag, meaning this clause has been processed by the IME and is awaiting acceptance/confirmation by the user The converted flag, meaning this clause has been processed by the IME and is awaiting acceptance/confirmation by the user relativeEnd The relative end of the composition clause, relative to the beginning of the inline edit session. The relative end of the composition clause, relative to the beginning of the inline edit session. i.e. 0 = the start of the text the IME can see (there may be text before that in the edit field) relativeStart The relative start from the beginning of the inline edit session i.e. The relative start from the beginning of the inline edit session i.e. 0 = the start of the text the IME can see (there may be text before that in the edit field) selected The selected flag, meaning this composition clause is active and being lengthened or shortened or edited with the IME, and the neighboring clauses are not. The selected flag, meaning this composition clause is active and being lengthened or shortened or edited with the IME, and the neighboring clauses are not.