| org.w3c.dom.events.Event
All known Subclasses: org.apache.batik.dom.events.AbstractEvent,
| Event | | public interface Event (Code) | | The 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. More specific context information is
passed to event listeners by deriving additional interfaces from
Event which contain information directly relating to the
type of event they represent. These derived interfaces are also
implemented by the object passed to the event listener.
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 |
| Field Summary | |
| final public static short | AT_TARGET
The current event is in the target phase, i.e. | | final public static short | BUBBLING_PHASE
The current event phase is the bubbling phase. | | final public static short | CAPTURING_PHASE
The current event phase is the capture phase. |
| Method Summary | |
| public boolean | getBubbles()
Used to indicate whether or not an event is a bubbling event. | | public boolean | getCancelable()
Used to indicate whether or not an event can have its default action
prevented (see also ). | | public EventTarget | getCurrentTarget()
Used to indicate the EventTarget whose
EventListeners are currently being processed. | | public boolean | getDefaultPrevented()
Used to indicate whether Event.preventDefault() has been
called for this event. | | public short | getEventPhase()
Used to indicate which phase of event flow is currently being
accomplished. | | public String | getNamespaceURI()
The namespace URI associated with this event at creation time, or
null if it is unspecified. | | public EventTarget | getTarget()
Used to indicate the event target. | | public long | getTimeStamp()
Used to specify the time at which the event was created in
milliseconds relative to 1970-01-01T00:00:00Z. | | public String | getType()
The local name of the event type. | | public void | initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
The initEvent method is used to initialize the value of
an Event created through the
DocumentEvent.createEvent method. | | public void | initEventNS(String namespaceURIArg, String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
The initEventNS method is used to initialize the value of
an Event object and has the same behavior as
Event.initEvent(). | | public void | preventDefault()
If an event is cancelable, the preventDefault method is
used to signify 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 ), and thus independently of event groups. | | public void | stopImmediatePropagation()
This method is used to prevent event listeners of the same group to be
triggered and, unlike Event.stopPropagation() its effect
is immediate (see ). | | public void | stopPropagation()
This method is used to prevent event listeners of the same group to be
triggered but its effect is deferred until all event listeners
attached on the Event.currentTarget have been triggered
(see ). |
| AT_TARGET | | final public static short AT_TARGET(Code) | | The current event is in the target phase, i.e. it is being evaluated
at the event target.
|
| BUBBLING_PHASE | | final public static short BUBBLING_PHASE(Code) | | The current event phase is the bubbling phase.
|
| CAPTURING_PHASE | | final public static short CAPTURING_PHASE(Code) | | The current event phase is the capture phase.
|
| getBubbles | | public boolean getBubbles()(Code) | | 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.
|
| getCancelable | | public boolean getCancelable()(Code) | | 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
.
|
| getCurrentTarget | | public EventTarget getCurrentTarget()(Code) | | 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 .
|
| getDefaultPrevented | | public boolean getDefaultPrevented()(Code) | | Used to indicate whether Event.preventDefault() has been
called for this event.
since:
DOM Level 3 |
| getEventPhase | | public short getEventPhase()(Code) | | Used to indicate which phase of event flow is currently being
accomplished.
|
| getNamespaceURI | | public String getNamespaceURI()(Code) | | The namespace URI associated with this event at creation time, or
null if it is unspecified.
For events initialized with a DOM Level 2 Events method, such as
Event.initEvent(), this is always null.
since:
DOM Level 3 |
| getTarget | | public EventTarget getTarget()(Code) | | Used to indicate the event target. This attribute contains the target
node when used with the .
|
| getTimeStamp | | public long getTimeStamp()(Code) | | 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.
|
| initEvent | | public void initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)(Code) | | The initEvent method is used to initialize the value 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.
Parameters:
eventTypeArg - Specifies Event.type, the local name of the event type.
Parameters:
canBubbleArg - Specifies Event.bubbles. This parameter overrides the intrinsic bubbling behavior of the event.
Parameters:
cancelableArg - Specifies Event.cancelable. This parameter overrides the intrinsic cancelable behavior of the event. |
| initEventNS | | public void initEventNS(String namespaceURIArg, String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)(Code) | | The initEventNS method is used to initialize the value of
an Event object and has the same behavior as
Event.initEvent().
Parameters:
namespaceURIArg - Specifies Event.namespaceURI, the namespace URI associated with this event, or null if no namespace.
Parameters:
eventTypeArg - Refer to the Event.initEvent() method for a description of this parameter.
Parameters:
canBubbleArg - Refer to the Event.initEvent() method for a description of this parameter.
Parameters:
cancelableArg - Refer to the Event.initEvent() method for a description of this parameter.
since:
DOM Level 3 |
| preventDefault | | public void preventDefault()(Code) | | If an event is cancelable, the preventDefault method is
used to signify 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 ), and thus independently of event groups.
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.
|
| stopImmediatePropagation | | public void stopImmediatePropagation()(Code) | | This method is used to prevent event listeners of the same group to be
triggered and, unlike Event.stopPropagation() its effect
is immediate (see ). Once it has been called, further calls to that
method have no additional effect.
Note: This method does not prevent the default action from
being invoked; use Event.preventDefault() for that
effect.
since:
DOM Level 3 |
| stopPropagation | | public void stopPropagation()(Code) | | This method is used to prevent event listeners of the same group to be
triggered but its effect is deferred until all event listeners
attached on the Event.currentTarget have been triggered
(see ). Once it has been called, further calls to that method have no
additional effect.
Note: This method does not prevent the default action from
being invoked; use Event.preventDefault() for that
effect.
|
|
|