elemental.events

Interface CompositionEvent

All Superinterfaces:

Event, UIEvent

All Known Implementing Classes:

JsCompositionEvent

public interface CompositionEvent
extends UIEvent

dom/interfaces/events/nsIDOMCompositionEvent.idlScriptable

An event interface for composition events

1.0

11.0

Introduced

Gecko 9.0

Inherits from: nsIDOMUIEvent Last changed in Gecko 9.0 (Firefox 9.0 / Thunderbird 9.0 / SeaMonkey 2.6)

The DOM CompositionEvent represents events that occur due to the user indirectly entering text.

Field Summary

Fields inherited from interface elemental.events.Event

AT_TARGET, BEFORECOPY, BEFORECUT, BEFOREPASTE, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTEXTMENU, COPY, CUT, DBLCLICK, DRAG, DRAGEND, DRAGENTER, DRAGLEAVE, DRAGOVER, DRAGSTART, DROP, ERROR, FOCUS, FOCUSIN, FOCUSOUT, INPUT, INVALID, KEYDOWN, KEYPRESS, KEYUP, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOUSEWHEEL, NONE, PASTE, RESIZE, SCROLL, SELECTSTART, SUBMIT, TOUCHCANCEL, TOUCHEND, TOUCHMOVE, TOUCHSTART, WEBKITANIMATIONEND, WEBKITANIMATIONITERATION, WEBKITANIMATIONSTART, WEBKITTRANSITIONEND

Method Summary

Modifier and Type	Method and Description
String	getData() For compositionstart events, this is the currently selected text that will be replaced by the string being composed.
void	initCompositionEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Window viewArg, String dataArg) Initializes the attributes of a composition event.

Methods inherited from interface elemental.events.UIEvent

getCharCode, getDetail, getKeyCode, getLayerX, getLayerY, getPageX, getPageY, getView, getWhich, initUIEvent

Methods inherited from interface elemental.events.Event

getClipboardData, getCurrentTarget, getEventPhase, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isBubbles, isCancelable, isCancelBubble, isDefaultPrevented, isReturnValue, preventDefault, setCancelBubble, setReturnValue, stopImmediatePropagation, stopPropagation

Method Detail

getData

String getData()

For compositionstart events, this is the currently selected text that will be replaced by the string being composed. This value doesn't change even if content changes the selection range; rather, it indicates the string that was selected when composition started.

For compositionupdate , this is the string as it stands currently as editing is ongoing.

For compositionend events, this is the string as committed to the editor.

Read only.

initCompositionEvent

void initCompositionEvent(String typeArg,
                          boolean canBubbleArg,
                          boolean cancelableArg,
                          Window viewArg,
                          String dataArg)

Initializes the attributes of a composition event.

Parameters

typeArg

The type of composition event; this will be one of compositionstart, compositionupdate, or compositionend.

canBubbleArg

Whether or not the event can bubble.

cancelableArg

Whether or not the event can be canceled.

viewArg

?

dataArg

The value of the data attribute.

localeArg

The value of the locale attribute.