Xerces 1.0.0

org.apache.xerces.domx.events
Interface Event

All Known Subinterfaces:
MutationEvent, UIEvent

public interface Event

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.

Since:
DOM Level 2

Field Summary
static short AT_TARGET
           
static short BUBBLING_PHASE
           
static short CAPTURING_PHASE
           
 
Method Summary
 boolean getBubbles()
          The bubbles property indicates whether or not an event is a bubbling event.
 boolean getCancelable()
          The cancelable property indicates whether or not an event can have its default action prevented.
 Node getCurrentNode()
          The currentNode property indicates to which Node the event is currently being dispatched.
 short getEventPhase()
          The eventPhase property indicates which phase of event flow is currently being evaluated.
 EventTarget getTarget()
          The target property indicates the EventTarget to which the event was originally dispatched.
 java.lang.String getType()
          The type property represents the event name as a string property.
 void initEvent(java.lang.String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
           
 void preventDefault()
          If an event is cancelable, the preventCapture method is used to signify that the event is to be canceled.
 void stopPropagation()
          preventCapture() and preventBubble() were replaced by stopPropigation.
 

Field Detail

BUBBLING_PHASE

public static final short BUBBLING_PHASE

CAPTURING_PHASE

public static final short CAPTURING_PHASE

AT_TARGET

public static final short AT_TARGET
Method Detail

getBubbles

public boolean getBubbles()
The bubbles property indicates whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.

getCancelable

public boolean getCancelable()
The cancelable property indicates whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false.

getCurrentNode

public Node getCurrentNode()
The currentNode property indicates to which Node the event is currently being dispatched. This is particularly useful during capturing and bubbling.

getEventPhase

public short getEventPhase()
The eventPhase property indicates which phase of event flow is currently being evaluated.

getTarget

public EventTarget getTarget()
The target property indicates the EventTarget to which the event was originally dispatched.

getType

public java.lang.String getType()
The type property represents the event name as a string property.

initEvent

public void initEvent(java.lang.String eventTypeArg,
                      boolean canBubbleArg,
                      boolean cancelableArg)
Parameters:
eventTypeArg - Specifies the event type.
canBubbleArg - Specifies whether or not the event can bubble.
cancelableArg - Specifies whether or not the event's default action can be prevented.

stopPropagation

public void stopPropagation()
preventCapture() and preventBubble() were replaced by stopPropigation.

preventDefault

public void preventDefault()
If an event is cancelable, the preventCapture method is used to signify that the event is to be canceled. 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.

Xerces 1.0.0