Packages

com.aspose.html.dom.events

Interfaces

Classes

java.lang.Object
- com.aspose.html.dom.DOMObject
- - com.aspose.html.dom.events.Event

Direct Known Subclasses:

CustomEvent, ErrorEvent, SVGZoomEvent, TimeEvent, UIEvent
```
@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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Event.EventInit` Represents a dictionary that is having optional arguments for setting the details information about the event.

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.

Fields inherited from class com.aspose.html.dom.DOMObject
PropertyChanged

Constructor Summary

Constructors
Constructor and Description
`Event(String type)` Initializes a new instance of the `Event` class.
`Event(String type, Event.EventInit eventInitDict)` Initializes a new instance of the `Event` class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Event`	`createDOMContentLoadedEvent(Event.EventInit eventInit)`
`static Event`	`createError(Exception exception)`
`static Event`	`createEvent(String type)`
`static Event`	`createEvent(String type, Event.EventInit eventInit)`
`static Event`	`createEventByType(String eventType)`
`boolean`	`dispatch(EventTarget targetOverride)`
`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 `IEventTarget` whose `IEventListener`s are currently being processed.
`boolean`	`getDefaultPrevented()` Returns true if preventDefault() was invoked while the cancelable attribute value is true, and false otherwise.
`int`	`getEventPhase()` Used to indicate which phase of event flow is currently being evaluated.
`EventTarget`	`getTarget()` Used to indicate the `IEventTarget` 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.
`String`	`getType()` The name of the event (case-insensitive).
`void`	`initEvent(String type, boolean bubbles, boolean cancelable)` The `initEvent(String, boolean, boolean)` method is used to initialize the value of an `Event` created through the `IDocumentEvent` interface.
`boolean`	`isTrusted()` The isTrusted attribute must return the value it was initialized to.
`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`	`setCurrentTarget(EventTarget value)` Used to indicate the `IEventTarget` whose `IEventListener`s are currently being processed.
`void`	`setEventPhase(int value)` Used to indicate which phase of event flow is currently being evaluated.
`void`	`setTarget(EventTarget value)` Used to indicate the `IEventTarget` to which the event was originally dispatched.
`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.
`void`	`stopPropagation()` The `stopPropagation` method is used prevent further propagation of an event during event flow.

Methods inherited from class com.aspose.html.dom.DOMObject
fireNotifyPropertyChanged, getCurrentValues, getRuntimesBinding, setCurrentValues, setField, setRuntimesBinding

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE_PHASE
```
@DOMNameAttribute(name="NONE")
public static final int NONE_PHASE
```
    Events not currently dispatched are in this phase.
    
    See Also:
    
    Constant Field Values
  - CAPTURING_PHASE
```
@DOMNameAttribute(name="CAPTURING_PHASE")
public static final int CAPTURING_PHASE
```
    The event is currently being evaluated at the target IEventTarget.
    
    See Also:
    
    Constant Field Values
  - AT_TARGET_PHASE
```
@DOMNameAttribute(name="AT_TARGET")
public static final int AT_TARGET_PHASE
```
    The current event phase is the capturing phase.
    
    See Also:
    
    Constant Field Values
  - BUBBLING_PHASE
```
@DOMNameAttribute(name="BUBBLING_PHASE")
public static final int BUBBLING_PHASE
```
    The current event phase is the bubbling phase.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Event
```
public Event(String type)
```
    Initializes a new instance of the Event class.
    
    Parameters:
    
    type - The event type.
  - Event
```
public Event(String type,
             Event.EventInit eventInitDict)
```
    Initializes a new instance of the Event class.
    
    Parameters:
    
    type - The event type.
    
    eventInitDict - The event initialize dictionary.
- Method Detail
  - createDOMContentLoadedEvent
```
public static Event createDOMContentLoadedEvent(Event.EventInit eventInit)
```
  - createEvent
```
public static Event createEvent(String type)
```
  - createEvent
```
public static Event createEvent(String type,
                                Event.EventInit eventInit)
```
  - createError
```
public static Event createError(Exception exception)
```
  - createEventByType
```
public static Event createEventByType(String eventType)
```
  - getBubbles
```
@DOMNameAttribute(name="bubbles")
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
```
@DOMNameAttribute(name="cancelable")
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
```
@DOMNameAttribute(name="currentTarget")
 @DOMNullableAttribute
public EventTarget getCurrentTarget()
```
    Used to indicate the IEventTarget whose IEventListeners are currently being processed. This is particularly useful during capturing and bubbling.
  - setCurrentTarget
```
@DOMNameAttribute(name="currentTarget")
 @DOMNullableAttribute
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
```
@DOMNameAttribute(name="eventPhase")
public int getEventPhase()
```
    Used to indicate which phase of event flow is currently being evaluated.
  - setEventPhase
```
@DOMNameAttribute(name="eventPhase")
public void setEventPhase(int value)
```
    Used to indicate which phase of event flow is currently being evaluated.
  - getTarget
```
@DOMNameAttribute(name="target")
 @DOMNullableAttribute
public EventTarget getTarget()
```
    Used to indicate the IEventTarget to which the event was originally dispatched.
  - setTarget
```
@DOMNameAttribute(name="target")
 @DOMNullableAttribute
public void setTarget(EventTarget value)
```
    Used to indicate the IEventTarget to which the event was originally dispatched.
  - getTimeStamp
```
@DOMNameAttribute(name="timeStamp")
 @DOMTimeStampAttribute
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
```
@DOMNameAttribute(name="type")
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
```
@DOMNameAttribute(name="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.
  - initEvent
```
@DOMNameAttribute(name="initEvent")
public void initEvent(String type,
                                                           boolean bubbles,
                                                           boolean cancelable)
```
    The initEvent(String, boolean, boolean) method is used to initialize the value of an Event created through the IDocumentEvent interface.
    
    Parameters:
    
    type - The event 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(com.aspose.html.dom.events.Event) 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 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.
  - stopPropagation
```
@DOMNameAttribute(name="stopPropagation")
public void stopPropagation()
```
    The 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.
  - dispatch
```
public boolean dispatch(EventTarget targetOverride)
```

Packages

com.aspose.html.dom.events

Interfaces

Classes

Class Event

Nested Class Summary

Field Summary

Fields inherited from class com.aspose.html.dom.DOMObject

Constructor Summary

Method Summary

Methods inherited from class com.aspose.html.dom.DOMObject

Methods inherited from class java.lang.Object

Field Detail

NONE_PHASE

CAPTURING_PHASE

AT_TARGET_PHASE

BUBBLING_PHASE

Constructor Detail

Event

Event

Method Detail

createDOMContentLoadedEvent

createEvent

createEvent

createError

createEventByType

getBubbles

getCancelable

getCurrentTarget

setCurrentTarget

getEventPhase

setEventPhase

getTarget

setTarget

getTimeStamp

getType

getDefaultPrevented

isTrusted

initEvent

preventDefault

stopPropagation

stopImmediatePropagation

dispatch