Event interface is used to provide contextual information
* about an event to the listener processing the event. An object which
* implements the Event interface is passed as the parameter to
* an EventListener. The object passed to the event listener
* may also implement derived interfaces that provide access to information
* directly relating to the type of event they represent.
* To create an instance of the Event interface, use the
* DocumentEvent.createEvent("Event") method call.
*
See also the
Document Object Model (DOM) Level 3 Events Specification
.
* @since DOM Level 2
*/
public interface Event {
// PhaseType
/**
* The current event phase is the capture phase.
*/
public static final short CAPTURING_PHASE = 1;
/**
* The current event is in the target phase, i.e. it is being evaluated
* at the event target.
*/
public static final short AT_TARGET = 2;
/**
* The current event phase is the bubbling phase.
*/
public static final short BUBBLING_PHASE = 3;
/**
* The local name of the event type. The name must be an NCName as defined in [XML Namespaces 1.1]
* and is case-sensitive.
*/
public String getType();
/**
* Used to indicate the event target. This attribute contains the target
* node when used with the .
*/
public EventTarget getTarget();
/**
* Used to indicate the EventTarget whose
* EventListeners are currently being processed. This is
* particularly useful during the capture and bubbling phases. This
* attribute could contain the target node or a target ancestor when
* used with the .
*/
public EventTarget getCurrentTarget();
/**
* Used to indicate which phase of event flow is currently being
* accomplished.
*/
public short getEventPhase();
/**
* Used to indicate whether or not an event is a bubbling event. If the
* event can bubble the value is true, otherwise the value
* is false.
*/
public boolean getBubbles();
/**
* Used to indicate whether or not an event can have its default action
* prevented (see also ). If the default action can be prevented the
* value is true, otherwise the value is false
* .
*/
public boolean getCancelable();
/**
* Used to specify the time at which the event was created in
* milliseconds relative to 1970-01-01T00:00:00Z. Due to the fact that
* some systems may not provide this information the value of
* timeStamp may be not available for all events. When not
* available, the value is 0.
*/
public long getTimeStamp();
/**
* Prevents other event listeners from being triggered but its effect is
* deferred until all event listeners attached on the
* Event.currentTarget have been triggered . Once it has
* been called, further calls to this method have no additional effect.
*
Note: This method does not prevent the default action from
* being invoked; use Event.preventDefault() for that
* effect.
*/
public void stopPropagation();
/**
* Signifies that the event is to be canceled, meaning any default action
* normally taken by the implementation as a result of the event will
* not occur (see also ). Calling this method for a non-cancelable event
* has no effect.
*
Note: This method does not stop the event propagation; use
* Event.stopPropagation() or
* Event.stopImmediatePropagation() for that effect.
*/
public void preventDefault();
/**
* Initializes attributes of an Event created through the
* DocumentEvent.createEvent method. This method may only
* be called before the Event has been dispatched via the
* EventTarget.dispatchEvent() method. If the method is
* called several times before invoking
* EventTarget.dispatchEvent, only the final invocation
* takes precedence. This method has no effect if called after the event
* has been dispatched. If called from a subclass of the
* Event interface only the values specified in this method
* are modified, all other attributes are left unchanged.
*
This method sets the Event.type attribute to
* eventTypeArg, and Event.namespaceURI to
* null. To initialize an event with a namespace URI, use
* the Event.initEventNS() method.
* @param eventTypeArg Specifies Event.type, the local name
* of the event type.
* @param canBubbleArg Specifies Event.bubbles. This
* parameter overrides the intrinsic bubbling behavior of the event.
* @param cancelableArg Specifies Event.cancelable. This
* parameter overrides the intrinsic cancelable behavior of the event.
*
*/
public void initEvent(String eventTypeArg,
boolean canBubbleArg,
boolean cancelableArg);
/**
* Initializes attributes of an Event created through the
* DocumentEvent.createEvent method. This method may only
* be called before the Event has been dispatched via the
* EventTarget.dispatchEvent() method. If the method is
* called several times before invoking
* EventTarget.dispatchEvent, only the final invocation
* takes precedence. This method has no effect if called after the event
* has been dispatched. If called from a subclass of the
* Event interface only the values specified in this method
* are modified, all other attributes are left unchanged.
*
This method sets the Event.type attribute to
* eventTypeArg, and Event.namespaceURI to
* null. To initialize an event with a namespace URI, use
* the Event.initEventNS() method.
* @param eventTypeArg Specifies Event.type, the local name
* of the event type.
* @param canBubbleArg Specifies Event.bubbles. This
* parameter overrides the intrinsic bubbling behavior of the event.
* @param cancelableArg Specifies Event.cancelable. This
* parameter overrides the intrinsic cancelable behavior of the event.
* @param seekTo Specifies Event.seekTo. the int seekTo of event.
*
*/
public void initEvent(String eventTypeArg,
boolean canBubbleArg,
boolean cancelableArg,
int seekTo);
public int getSeekTo();
}