akasha

Class Event

java.lang.Object

akasha.core.JsObject

akasha.Event

Direct Known Subclasses:

AnimationEvent, AnimationPlaybackEvent, AudioProcessingEvent, BeforeUnloadEvent, BlobEvent, BluetoothAdvertisingEvent, ClipboardEvent, CloseEvent, CustomEvent, DeviceMotionEvent, DeviceOrientationEvent, ErrorEvent, ExtendableEvent, FormDataEvent, GamepadEvent, GPUUncapturedErrorEvent, HashChangeEvent, IDBVersionChangeEvent, MediaEncryptedEvent, MediaKeyMessageEvent, MediaQueryListEvent, MediaRecorderErrorEvent, MediaStreamTrackEvent, MessageEvent, OfflineAudioCompletionEvent, PageTransitionEvent, PopStateEvent, ProgressEvent, PromiseRejectionEvent, RTCDataChannelEvent, RTCDTMFToneChangeEvent, RTCErrorEvent, RTCPeerConnectionIceErrorEvent, RTCPeerConnectionIceEvent, RTCTrackEvent, SecurityPolicyViolationEvent, SpeechRecognitionErrorEvent, SpeechRecognitionEvent, SpeechSynthesisEvent, StorageEvent, SubmitEvent, TrackEvent, TransitionEvent, UIEvent, ValueEvent, WebGLContextEvent, XRInputSourceEvent, XRInputSourcesChangeEvent, XRReferenceSpaceEvent, XRSessionEvent

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Event")
public class Event
extends JsObject

The Event interface represents an event which takes place in the DOM.

See Also:

Event - MDN, (DOM) # interface-event

Field Summary

Fields

Modifier and Type	Field and Description
static int	AT_TARGET
static int	BUBBLING_PHASE
boolean	cancelBubble The cancelBubble property of the Event interface is a historical alias to Event.stopPropagation().
static int	CAPTURING_PHASE
static int	NONE
boolean	returnValue The Event property returnValue indicates whether the default action for this event has been prevented or not.

Constructor Summary

Constructors

Constructor and Description
Event(java.lang.String type) The Event() constructor creates a new Event.
Event(java.lang.String type, EventInit eventInitDict) The Event() constructor creates a new Event.

Method Summary

Modifier and Type	Method and Description
boolean	bubbles() The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM or not.
boolean	cancelable() The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.
boolean	composed() The read-only composed property of the Event interface returns a Boolean which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
@JsNonNull JsArray<EventTarget>	composedPath() The composedPath() method of the Event interface returns the event’s path which is an array of the objects on which listeners will be invoked.
EventTarget	currentTarget() The currentTarget read-only property of the Event interface identifies the current target for the event, as the event traverses the DOM.
boolean	defaultPrevented() The defaultPrevented read-only property of the Event interface returns a Boolean indicating whether or not the call to Event.preventDefault() canceled the event.
int	eventPhase() The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
void	initEvent(java.lang.String type) The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().
void	initEvent(java.lang.String type, boolean bubbles) The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().
void	initEvent(java.lang.String type, boolean bubbles, boolean cancelable) The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().
boolean	isTrusted() The isTrusted read-only property of the Event interface is a Boolean that is true when the event was generated by a user action, and false when the event was created or modified by a script or dispatched via EventTarget.dispatchEvent().
void	preventDefault() The Event interface's preventDefault() method tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.
EventTarget	srcElement() Initially implemented in Internet Explorer, Event.srcElement is a now-standard alias (defined in the DOM Standard but flagged as "historical") for the Event.target property.
void	stopImmediatePropagation() The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.
void	stopPropagation() The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.
EventTarget	target() The target property of the Event interface is a reference to the object onto which the event was dispatched.
double	timeStamp() The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.
java.lang.String	type() The type read-only property of the Event interface returns a string containing the event's type.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AT_TARGET

@JsOverlay
public static final int AT_TARGET

See Also:

Constant Field Values

BUBBLING_PHASE

@JsOverlay
public static final int BUBBLING_PHASE

See Also:

Constant Field Values

CAPTURING_PHASE

@JsOverlay
public static final int CAPTURING_PHASE

See Also:

Constant Field Values

NONE

@JsOverlay
public static final int NONE

See Also:

Constant Field Values

cancelBubble

public boolean cancelBubble

The cancelBubble property of the Event interface is a historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

See Also:

Event.cancelBubble - MDN, cancelBubble - DOM

returnValue

public boolean returnValue

The Event property returnValue indicates whether the default action for this event has been prevented or not.

See Also:

Event.returnValue - MDN, returnValue - DOM

Constructor Detail

Event

public Event(@Nonnull
             java.lang.String type,
             @Nonnull
             EventInit eventInitDict)

The Event() constructor creates a new Event.

See Also:

Event.Event - MDN, Event() - DOM

Event

public Event(@Nonnull
             java.lang.String type)

The Event() constructor creates a new Event.

See Also:

Event.Event - MDN, Event() - DOM

Method Detail

bubbles

@JsProperty(name="bubbles")
public boolean bubbles()

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM or not.

See Also:

Event.bubbles - MDN, Event.bubbles - DOM, Event.bubbles - Document Object Model (DOM) Level 2 Events Specification

cancelable

@JsProperty(name="cancelable")
public boolean cancelable()

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

See Also:

Event.cancelable - MDN, Event.cancelable - DOM, Event.cancelable - Document Object Model (DOM) Level 2 Events Specification

composed

@JsProperty(name="composed")
public boolean composed()

The read-only composed property of the Event interface returns a Boolean which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

See Also:

Event.composed - MDN, composed - DOM

currentTarget

@JsProperty(name="currentTarget")
 @Nullable
public EventTarget currentTarget()

The currentTarget read-only property of the Event interface identifies the current target for the event, as the event traverses the DOM. It always refers to the element to which the event handler has been attached, as opposed to Event.target, which identifies the element on which the event occurred and which may be its descendant.

See Also:

Event.currentTarget - MDN, Event.currentTarget - DOM, Event.currentTarget - DOM4, current event target - Document Object Model (DOM) Level 3 Events Specification, Event.currentTarget - Document Object Model (DOM) Level 2 Events Specification

defaultPrevented

@JsProperty(name="defaultPrevented")
public boolean defaultPrevented()

The defaultPrevented read-only property of the Event interface returns a Boolean indicating whether or not the call to Event.preventDefault() canceled the event.

See Also:

Event.defaultPrevented - MDN, Event.defaultPrevented() - DOM

eventPhase

@JsProperty(name="eventPhase")
 @EventPhase
public int eventPhase()

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

See Also:

Event.eventPhase - MDN, Event.eventPhase - DOM, Event.eventPhase - DOM4, Event.eventPhase - Document Object Model (DOM) Level 2 Events Specification

isTrusted

@JsProperty(name="isTrusted")
public boolean isTrusted()

The isTrusted read-only property of the Event interface is a Boolean that is true when the event was generated by a user action, and false when the event was created or modified by a script or dispatched via EventTarget.dispatchEvent().

See Also:

Event.isTrusted - MDN

srcElement

@JsProperty(name="srcElement")
 @Nullable
public EventTarget srcElement()

Initially implemented in Internet Explorer, Event.srcElement is a now-standard alias (defined in the DOM Standard but flagged as "historical") for the Event.target property. It's supported in all major browser engines, but only for compatibility reasons. Use Event.target instead.

See Also:

Event.srcElement - MDN, Event.srcElement - DOM

target

@JsProperty(name="target")
 @Nullable
public EventTarget target()

The target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

See Also:

Event.target - MDN, Event.target - DOM, Event.target - DOM4, Event.target - Document Object Model (DOM) Level 2 Events Specification

timeStamp

@JsProperty(name="timeStamp")
public double timeStamp()

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

See Also:

Event.timeStamp - MDN, Event.timeStamp - DOM

type

@JsProperty(name="type")
 @Nonnull
public java.lang.String type()

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

See Also:

Event.type - MDN, Event.type - DOM, Event.type - Document Object Model (DOM) Level 2 Events Specification

composedPath

public @JsNonNull JsArray<EventTarget> composedPath()

The composedPath() method of the Event interface returns the event’s path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

See Also:

Event.composedPath - MDN, composedPath() - DOM

initEvent

public void initEvent(@Nonnull
                      java.lang.String type,
                      boolean bubbles,
                      boolean cancelable)

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

See Also:

Event.initEvent - MDN, Event.initEvent() - DOM, Event.initEvent() - Document Object Model (DOM) Level 2 Events Specification

initEvent

public void initEvent(@Nonnull
                      java.lang.String type,
                      boolean bubbles)

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

See Also:

Event.initEvent - MDN, Event.initEvent() - DOM, Event.initEvent() - Document Object Model (DOM) Level 2 Events Specification

initEvent

public void initEvent(@Nonnull
                      java.lang.String type)

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

See Also:

Event.initEvent - MDN, Event.initEvent() - DOM, Event.initEvent() - Document Object Model (DOM) Level 2 Events Specification

preventDefault

public void preventDefault()

The Event interface's preventDefault() method tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.

See Also:

Event.preventDefault - MDN, Event.preventDefault() - DOM, Event.preventDefault() - Document Object Model (DOM) Level 2 Events Specification

stopImmediatePropagation

public void stopImmediatePropagation()

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

See Also:

Event.stopImmediatePropagation - MDN, Event.stopImmediatePropagation() - DOM

stopPropagation

public void stopPropagation()

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method.

See Also:

Event.stopPropagation - MDN, Event.stopPropagation() - DOM, Event.stopPropagation() - DOM4, Event.stopPropagation() - Document Object Model (DOM) Level 2 Events Specification