Class Index | File Index

Classes


Class gui.InputMethodEditor


Defined in: InputMethodEditor.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
gui.InputMethodEditor(inputMemberId, eventManager)
Challenges of note: - On FF & Chrome, the composition session is interrupted if the OdtCursor moves - On Safari, using Option+char incorrectly reports the following keypress event - On Chrome, using Option+char will include the following keypress in the composition event
Field Summary
Field Attributes Field Name and Description
<static>  
gui.InputMethodEditor.signalCompositionEnd
<static>  
gui.InputMethodEditor.signalCompositionStart
 
Subscribe to IME events
 
Unsubscribe from IME events
Method Summary
Method Attributes Method Name and Description
<inner>  
<inner>  
 
destroy(callback)
<inner>  
If the document has focus, queue up a window selection synchronization action to occur.
 
Handle a cursor registration event
 
removeCursor(memberid)
Handle a cursor removal event
<inner>  
Set the local cursor's current composition state.
<inner>  
Synchronizes the eventTrap's text with the compositionElement's text.
<inner>  
Synchronize the window's selection to the local user's cursor selection.
<inner>  
Class Detail
gui.InputMethodEditor(inputMemberId, eventManager)
Challenges of note: - On FF & Chrome, the composition session is interrupted if the OdtCursor moves - On Safari, using Option+char incorrectly reports the following keypress event - On Chrome, using Option+char will include the following keypress in the composition event
Parameters:
{!string} inputMemberId
{!gui.EventManager} eventManager
Field Detail
<static> gui.InputMethodEditor.signalCompositionEnd

<static> gui.InputMethodEditor.signalCompositionStart

subscribe
Subscribe to IME events

unsubscribe
Unsubscribe from IME events
Method Detail
<inner> addCompositionData(data)
Parameters:
{string} data

<inner> compositionEnd(e)
Parameters:
{!CompositionEvent} e

destroy(callback)
Parameters:
{function(!Error=)} callback

<inner> {undefined} handleCursorUpdated()
If the document has focus, queue up a window selection synchronization action to occur. If the document does not have focus, no action is necessary as the window selection will be resynchronized when focus is returned.
Returns:
{undefined}

{undefined} registerCursor(cursor)
Handle a cursor registration event
Parameters:
{!ops.OdtCursor} cursor
Returns:
{undefined}

{undefined} removeCursor(memberid)
Handle a cursor removal event
Parameters:
{!string} memberid
Member id of the removed cursor
Returns:
{undefined}

<inner> {undefined} setCursorComposing(state)
Set the local cursor's current composition state. If there is no local cursor, this function will do nothing
Parameters:
{!boolean} state
Returns:
{undefined}

<inner> {undefined} synchronizeCompositionText()
Synchronizes the eventTrap's text with the compositionElement's text.
Returns:
{undefined}

<inner> {undefined} synchronizeWindowSelection()
Synchronize the window's selection to the local user's cursor selection. This only changes whether the selection is a Range or a Caret (i.e., non-collapsed or collapsed). This allows most browsers to properly enable the cut/copy/paste items + shortcut keys.
Returns:
{undefined}

<inner> textInput(e)
Parameters:
{!Text} e

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 06 2015 04:10:40 GMT+0200 (MESZ)