blob: 174dfebfcc4c45181fe3277e1f894f0b26fc8448 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="IIMEClient,flash.text.ime.IIMEClient,compositionEndIndex,compositionStartIndex,converted,relativeEnd,relativeStart,selected,selectionActiveIndex,selectionAnchorIndex,verticalTextLayout,confirmComposition,getTextBounds,getTextInRange,selectRange,updateComposition"><title>flash.text.ime.IIMEClient</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'IIMEClient - ApacheFlex API Reference';
var baseRef = '../../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?flash/text/ime/IIMEClient.html&amp;flash/text/ime/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IIMEClient</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IIMEClient"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">flash.text.ime</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IIMEClient</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p>
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.
<p>To support inline IME, set the <code>imeClient</code> property of an <code>ImeEvent.IME_START_COMPOSITION</code> event to
an object which implements this interface.</p>
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="CompositionAttributeRange.html" target="">flash.text.ime.CompositionAttributeRange</a><br/>flash.events.ImeEvent:imeClient</div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#compositionEndIndex" class="signatureLink">compositionEndIndex</a> : int<div class="summaryTableDescription">[read-only]
The zero-based character index value of the end of the current edit session text (i.e.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#compositionStartIndex" class="signatureLink">compositionStartIndex</a> : int<div class="summaryTableDescription">[read-only]
The zero-based character index value of the start of the current edit session text (i.e.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#selectionActiveIndex" class="signatureLink">selectionActiveIndex</a> : int<div class="summaryTableDescription">[read-only]
The zero-based character index value of the last character in the current selection.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#selectionAnchorIndex" class="signatureLink">selectionAnchorIndex</a> : int<div class="summaryTableDescription">[read-only]
The zero-based character index value of the first character in the current selection.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#verticalTextLayout" class="signatureLink">verticalTextLayout</a> : Boolean<div class="summaryTableDescription">[read-only]
Indicates whether the text in the component is vertical or not.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#confirmComposition()" class="signatureLink">confirmComposition</a>(text:String = null, preserveSelection:Boolean = false):void</div><div class="summaryTableDescription">
Use this callback to end the inline editing session and confirm the text.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getTextBounds()" class="signatureLink">getTextBounds</a>(startIndex:int, endIndex:int):Rectangle</div><div class="summaryTableDescription">
This callback is used by the IME to query the bounding box of the text being edited with the IME client.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getTextInRange()" class="signatureLink">getTextInRange</a>(startIndex:int, endIndex:int):String</div><div class="summaryTableDescription">
Gets the specified range of text from the component.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#selectRange()" class="signatureLink">selectRange</a>(anchorIndex:int, activeIndex:int):void</div><div class="summaryTableDescription">
Sets the range of selected text in the component.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateComposition()" class="signatureLink">updateComposition</a>(text:String, attributes:Vector.&lt;<a href="../../../flash/text/ime/CompositionAttributeRange.html">CompositionAttributeRange</a>&gt;, compositionStartIndex:int, compositionEndIndex:int):void</div><div class="summaryTableDescription">
Callback for updating the contents of the inline editing session.</div></td><td class="summaryTableOwnerCol">IIMEClient</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th>&nbsp;</th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:imeStartComposition" class="signatureLink">imeStartComposition</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the user begins to use an IME (input method editor).</td><td class="summaryTableOwnerCol">IIMEClient</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:textInput" class="signatureLink">textInput</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the user enters text.</td><td class="summaryTableOwnerCol">IIMEClient</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="compositionEndIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compositionEndIndex</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>compositionEndIndex:int</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
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).
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get compositionEndIndex():int</code><br/></div><a name="propertyDetail"></a><a name="compositionStartIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">compositionStartIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>compositionStartIndex:int</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
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).
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get compositionStartIndex():int</code><br/></div><a name="propertyDetail"></a><a name="selectionActiveIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectionActiveIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>selectionActiveIndex:int</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
The zero-based character index value of the last character in the current selection.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get selectionActiveIndex():int</code><br/></div><a name="propertyDetail"></a><a name="selectionAnchorIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectionAnchorIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>selectionAnchorIndex:int</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
The zero-based character index value of the first character in the current selection.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get selectionAnchorIndex():int</code><br/></div><a name="propertyDetail"></a><a name="verticalTextLayout"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalTextLayout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>verticalTextLayout:Boolean</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
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).
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get verticalTextLayout():Boolean</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="confirmComposition()"></a><a name="confirmComposition(String,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">confirmComposition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function confirmComposition(text:String = null, preserveSelection:Boolean = false):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
Use this callback to end the inline editing session and confirm the text.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">text</span>:String</code> (default = <code>null</code>)<code></code> &mdash; the final state of the text in the inline session (the text that got confirmed).
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">preserveSelection</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; when true, you should not reset the current selection to the end of the confirmed text.
</td></tr></table></p></div><a name="getTextBounds()"></a><a name="getTextBounds(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getTextBounds</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function getTextBounds(startIndex:int, endIndex:int):Rectangle</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
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.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; an integer that specifies the starting location of the range of text for which you need to measure the bounding box.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">endIndex</span>:int</code> &mdash; Optional; an integer that specifies the ending location of the range of text for which you need to measure the bounding box.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Rectangle</code> &mdash; the bounding box of the specified range of text, or <code>null</code> if either or both of the indexes are invalid.
The same value should be returned independant of whether <code>startIndex</code> is greater or less than <code>endIndex</code>.
</td></tr></table></div><a name="getTextInRange()"></a><a name="getTextInRange(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getTextInRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function getTextInRange(startIndex:int, endIndex:int):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
Gets the specified range of text from the component. This method is called during IME reconversion.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; an integer that specifies the starting location of the range of text to be retrieved.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">endIndex</span>:int</code> &mdash; an integer that specifies the ending location of the range of text to be retrieved.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> &mdash; The requested text, or <code>null</code> 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 <code>startIndex</code> is greater or less than <code>endIndex</code>.
</td></tr></table></div><a name="selectRange()"></a><a name="selectRange(int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function selectRange(anchorIndex:int, activeIndex:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
Sets the range of selected text in the component.
If either of the arguments is out of bounds the selection should not be changed.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">anchorIndex</span>:int</code> &mdash; The zero-based index value of the character at the anchor end of the selection
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">activeIndex</span>:int</code> &mdash; The zero-based index value of the character at the active end of the selection.
</td></tr></table></p></div><a name="updateComposition()"></a><a name="updateComposition(String,Vector$flash.text.ime.CompositionAttributeRange,int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateComposition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function updateComposition(text:String, attributes:Vector.&lt;<a href="../../../flash/text/ime/CompositionAttributeRange.html">CompositionAttributeRange</a>&gt;, compositionStartIndex:int, compositionEndIndex:int):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>AIR 1.0, Flash Player 10.1</td></tr></table><p></p><p></p><p>
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.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">text</span>:String</code> &mdash; contains the text of the inline edit session from the IME
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">attributes</span>:Vector.&lt;<a href="../../../flash/text/ime/CompositionAttributeRange.html">CompositionAttributeRange</a>&gt;</code> &mdash; contains an array of composition clauses with adornment info
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">compositionStartIndex</span>:int</code> &mdash; start of the inline session relative to the start of the text object
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">compositionEndIndex</span>:int</code> &mdash; end of the inline session relative to the start of the text object
</td></tr></table></p></div><div class="detailSectionHeader"> Event Detail </div><a name="event:imeStartComposition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">imeStartComposition</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><code>flash.IMEEvent.IME_START_COMPOSITION</code><br/><span class="label">IME_START_COMPOSITION.type property = </span><code>flash.events.IMEEvent.IME_START_COMPOSITION</code><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Dispatched when the user begins to use an IME (input method editor).
</p></div><a name="event:textInput"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">textInput</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><code>flash.TextEvent.TEXT_INPUT</code><br/><span class="label">TEXT_INPUT.type property = </span><code>flash.events.TextEvent.TEXT_INPUT</code><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Dispatched when the user enters text. For IME (input method editor) clients, the receiver should
insert the string contained in the event object's <code>text</code> property at the current insertion point.
</p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 -->