com.aspose.html.dom.events

Class Event

  • Direct Known Subclasses:
    ErrorEvent


    @DOMObjectAttribute
     @DOMNameAttribute(name="Event")
    public class Event
    extends DOMObject

    The Event is used to provide contextual information about an event to the handler processing the event.


    An object which implements the Event 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.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int AT_TARGET_PHASE
      The current event phase is the capturing phase.
      static int BUBBLING_PHASE
      The current event phase is the bubbling phase.
      static int CAPTURING_PHASE
      The event is currently being evaluated at the target IEventTarget.
      static int NONE_PHASE
      Events not currently dispatched are in this phase.
    • Constructor Summary

      Constructors 
      Constructor and Description
      Event(String type, boolean bubbles, boolean cancelable)
      Initializes a new instance of the Event class.
      Event(String type, boolean bubbles, boolean cancelable, IBrowsingContext context)
      Initializes a new instance of the Event class.
      Event(String type, IBrowsingContext context)
      Initializes a new instance of the Event class.
    • Constructor Detail

      • Event

        public Event(String type,
                     IBrowsingContext context)

        Initializes a new instance of the Event class.

        Parameters:
        type - The event type.
        context - The context for IScriptWrapper.
      • Event

        public Event(String type,
                     boolean bubbles,
                     boolean cancelable,
                     IBrowsingContext context)

        Initializes a new instance of the Event class.

        Parameters:
        type - The event type.
        bubbles - if set to true [bubbles].
        cancelable - if set to true [cancelable].
        context - The context.
    • Method Detail

      • isStopPropagation

        public boolean isStopPropagation()
      • isStopPropagation

        public void isStopPropagation(boolean value)
      • isStopImmediatePropagation

        public boolean isStopImmediatePropagation()
      • isStopImmediatePropagation

        public void isStopImmediatePropagation(boolean value)
      • isCanceled

        public boolean isCanceled()
      • isCanceled

        public void isCanceled(boolean value)
      • isInitialized

        public boolean isInitialized()
      • isInitialized

        public void isInitialized(boolean value)
      • isDispatch

        public boolean isDispatch()
      • isDispatch

        public void isDispatch(boolean value)
      • getBubbles

        public boolean getBubbles()

        Used to indicate 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()

        Used to indicate 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.

      • getCurrentTarget

        public EventTarget getCurrentTarget()

        Used to indicate the IEventTarget whose IEventListeners are currently being processed. This is particularly useful during capturing and bubbling.

      • setCurrentTarget

        public void setCurrentTarget(EventTarget value)

        Used to indicate the IEventTarget whose IEventListeners are currently being processed. This is particularly useful during capturing and bubbling.

      • getEventPhase

        public int getEventPhase()

        Used to indicate which phase of event flow is currently being evaluated.

      • setEventPhase

        public void setEventPhase(int value)

        Used to indicate which phase of event flow is currently being evaluated.

      • getTarget

        public EventTarget getTarget()

        Used to indicate the IEventTarget to which the event was originally dispatched.

      • setTarget

        public void setTarget(EventTarget value)

        Used to indicate the IEventTarget to which the event was originally dispatched.

      • getTimeStamp

        public long getTimeStamp()

        Used to specify the time (in milliseconds relative to the epoch) at which the event was created. 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, 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.

      • getType

        public String getType()

        The name of the event (case-insensitive). The name must be an XML name.

      • getDefaultPrevented

        @DOMNameAttribute(name="defaultPrevented")
        public boolean getDefaultPrevented()

        Returns true if preventDefault() was invoked while the cancelable attribute value is true, and false otherwise.

        Value: true if [default prevented]; otherwise, false.
      • isTrusted

        public boolean isTrusted()

        The isTrusted attribute must return the value it was initialized to. When an event is created the attribute must be initialized to false.

        Value: true if this instance is trusted; otherwise, false.
      • setTrusted

        public void setTrusted(boolean value)

        The isTrusted attribute must return the value it was initialized to. When an event is created the attribute must be initialized to false.

        Value: true if this instance is trusted; otherwise, false.
      • initEvent

        @DOMNameAttribute(name="initEvent")
        public void initEvent(String type,
                                                                   boolean bubbles,
                                                                   boolean cancelable)

        The Event.InitEvent method is used to initialize the value of an Event created through the IDocumentEvent interface.

        Parameters:
        type - The type.
        bubbles - if set to true [bubbles].
        cancelable - if set to true [cancelable].


        This method may only be called before the Event has been dispatched via the IEventTarget.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.

      • preventDefault

        @DOMNameAttribute(name="preventDefault")
        public void preventDefault()

        If an event is cancelable, the IEvent.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 IEvent.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 IEvent.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.

      • stopPropagation

        @DOMNameAttribute(name="stopPropagation")
        public void stopPropagation()

        The IEvent.StopPropagation method is used prevent further propagation of an event during event flow.


        If this method is called by any IEventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current IEventTarget before event flow stops. This method may be used during any stage of event flow.

      • stopImmediatePropagation

        @DOMNameAttribute(name="stopImmediatePropagation")
        public void stopImmediatePropagation()

        Invoking this method prevents event from reaching any event listeners registered after the current one and when dispatched in a tree also prevents event from reaching any other objects.