org.apache.batik.w3c.dom.events.TextEvent Maven / Gradle / Ivy
/*
* Copyright (c) 2006 World Wide Web Consortium,
*
* (Massachusetts Institute of Technology, European Research Consortium for
* Informatics and Mathematics, Keio University). All Rights Reserved. This
* work is distributed under the W3C(r) Software License [1] in the hope that
* it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
*/
package org.apache.batik.w3c.dom.events;
import org.w3c.dom.events.UIEvent;
import org.w3c.dom.views.AbstractView;
/**
* The TextEvent interface provides specific contextual
* information associated with Text Events.
* To create an instance of the TextEvent interface, use the
* DocumentEvent.createEvent("TextEvent") method call.
*
See also the
Document Object Model (DOM) Level 3 Events Specification
.
* @since DOM Level 3
*/
public interface TextEvent extends UIEvent {
/**
* data holds the value of the characters generated by the
* character device. This may be a single Unicode character or a
* non-empty sequence of Unicode characters [Unicode]. Characters should be normalized as defined by the Unicode
* normalization form NFC, defined in [UAX #15]. This attribute
* cannot be null or contain the empty string.
*/
String getData();
/**
* The initTextEvent method is used to initialize the value
* of a TextEvent object and has the same behavior as
* UIEvent.initUIEvent(). The value of
* UIEvent.detail remains undefined.
* @param typeArg Refer to the UIEvent.initUIEvent() method
* for a description of this parameter.
* @param canBubbleArg Refer to the UIEvent.initUIEvent()
* method for a description of this parameter.
* @param cancelableArg Refer to the UIEvent.initUIEvent()
* method for a description of this parameter.
* @param viewArg Refer to the UIEvent.initUIEvent() method
* for a description of this parameter.
* @param dataArg Specifies TextEvent.data.
*/
void initTextEvent(String typeArg,
boolean canBubbleArg,
boolean cancelableArg,
AbstractView viewArg,
String dataArg);
/**
* The initTextEventNS method is used to initialize the
* value of a TextEvent object and has the same behavior as
* UIEvent.initUIEventNS(). The value of
* UIEvent.detail remains undefined.
* @param namespaceURI Refer to the UIEvent.initUIEventNS()
* method for a description of this parameter.
* @param type Refer to the UIEvent.initUIEventNS() method
* for a description of this parameter.
* @param canBubbleArg Refer to the UIEvent.initUIEventNS()
* method for a description of this parameter.
* @param cancelableArg Refer to the UIEvent.initUIEventNS()
* method for a description of this parameter.
* @param viewArg Refer to the UIEvent.initUIEventNS()
* method for a description of this parameter.
* @param dataArg Refer to the TextEvent.initTextEvent()
* method for a description of this parameter.
*/
void initTextEventNS(String namespaceURI,
String type,
boolean canBubbleArg,
boolean cancelableArg,
AbstractView viewArg,
String dataArg);
}