-
public interface DocumentEvent
TheDocumentEvent
interface provides a mechanism by which the user can create an Event of a type supported by the implementation. It is expected that theDocumentEvent
interface will be implemented on the same object which implements theDocument
interface in an implementation which supports the Event model.See also the Document Object Model (DOM) Level 2 Events Specification.
- Since:
- 1.5, DOM Level 2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Event
createEvent(String eventType)
-
-
-
Method Detail
createEvent
Event createEvent(String eventType) throws DOMException
- Parameters:
eventType
- TheeventType
parameter specifies the type ofEvent
interface to be created. If theEvent
interface specified is supported by the implementation this method will return a newEvent
of the interface type requested. If theEvent
is to be dispatched via thedispatchEvent
method the appropriate event init method must be called after creation in order to initialize theEvent
's values. As an example, a user wishing to synthesize some kind ofUIEvent
would callcreateEvent
with the parameter "UIEvents". TheinitUIEvent
method could then be called on the newly createdUIEvent
to set the specific type of UIEvent to be dispatched and set its context information.ThecreateEvent
method is used in creatingEvent
s when it is either inconvenient or unnecessary for the user to create anEvent
themselves. In cases where the implementation providedEvent
is insufficient, users may supply their ownEvent
implementations for use with thedispatchEvent
method.- Returns:
-
The newly created
Event
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if the implementation does not support the type ofEvent
interface requested
-