|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Event
interface is used to provide contextual information
about an event to the handler processing the event. An object which implements
the Event
interface is generally passed as the first parameter to
an event handler. More specific context information is passed to event handlers
by deriving additional interfaces from Event
which contain
information directly relating to the type of event they accompany. These
derived interfaces are also implemented by the object passed to the event
listener.
See also the Document Object Model (DOM) Level 2 Events Specification.
Field Summary | |
static short |
AT_TARGET
The event is currently being evaluated at the target EventTarget . |
static short |
BUBBLING_PHASE
The current event phase is the bubbling phase. |
static short |
CAPTURING_PHASE
The current event phase is the capturing phase. |
Method Summary | |
boolean |
getBubbles()
Used to indicate whether or not an event is a bubbling event. |
boolean |
getCancelable()
Used to indicate whether or not an event can have its default action prevented. |
EventTarget |
getCurrentTarget()
Used to indicate the EventTarget whose EventListeners are currently
being processed. |
short |
getEventPhase()
Used to indicate which phase of event flow is currently being evaluated. |
EventTarget |
getTarget()
Used to indicate the EventTarget to which the event was originally dispatched. |
long |
getTimeStamp()
Used to specify the time (in milliseconds relative to the epoch) at which the event was created. |
java.lang.String |
getType()
The name of the event (case-insensitive). |
void |
initEvent(java.lang.String eventTypeArg,
boolean canBubbleArg, boolean cancelableArg) The initEvent method is used to initialize the value of an
Event created through the DocumentEvent
interface. |
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. |
void |
stopPropagation()
The stopPropagation method is used prevent further propagation of an
event during event flow. |
Field Detail |
public static final short CAPTURING_PHASE
public static final short AT_TARGET
EventTarget
.public static final short BUBBLING_PHASE
Method Detail |
public java.lang.String getType()
public EventTarget getTarget()
EventTarget
to which the event was
originally dispatched.public EventTarget getCurrentTarget()
EventTarget
whose
EventListeners
are currently being processed. This is particularly
useful during capturing and bubbling.public short getEventPhase()
public boolean getBubbles()
public boolean getCancelable()
public long getTimeStamp()
timeStamp
may be not available for all
events. When not available, a value of 0 will be returned. Examples of epoch
time are the time of the system start or 0:0:0 UTC 1st January 1970.public void stopPropagation()
stopPropagation
method is used prevent further propagation
of an event during event flow. If this method is called by any
EventListener
the event will cease propagating through the tree.
The event will complete dispatch to all listeners on the current
EventTarget
before event flow stops. This method may be used
during any stage of event flow.public void preventDefault()
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.
If, during any stage of event flow, the preventDefault
method is
called the event is canceled. Any default action associated with the event will
not occur. Calling this method for a non-cancelable event has no effect. Once
preventDefault
has been called it will remain in effect throughout
the remainder of the event's propagation. This method may be used during any
stage of event flow.public void initEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
initEvent
method is used to initialize the value of an
Event
created through the DocumentEvent
interface.
This method may only be called before the Event
has been
dispatched via the dispatchEvent
method, though it may be called
multiple times during that phase if necessary. If called multiple times the
final invocation takes precedence. If called from a subclass of
Event
interface only the values specified in the
initEvent
method are modified, all other attributes are left
unchanged.eventTypeArg
- Specifies the event type. This type may be any
event type currently defined in this specification or a new event type.. The
string must be an XML name. Any new event type must not begin with any upper,
lower, or mixed case version of the string "DOM". This prefix is reserved for
future DOM event sets. It is also strongly recommended that third parties
adding their own events use their own prefix to avoid confusion and lessen the
probability of conflicts with other new events.canBubbleArg
- Specifies whether or not the event can
bubble.cancelableArg
- Specifies whether or not the event's default
action can be prevented.
|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2000 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document useand software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.