elemental.events.CompositionEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package elemental.events;
import elemental.html.Window;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * 

dom/interfaces/events/nsIDOMCompositionEvent.idlScriptable
An event interface for composition events1.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.
  */
public interface CompositionEvent extends UIEvent {


  /**
    * 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.
    */
  String getData();


  /**
    * 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.


    */
  void initCompositionEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Window viewArg, String dataArg);
}