Interface UIEvent

All Superinterfaces:: Event

All Known Subinterfaces:: MouseEvent

public interface UIEvent extends Event

The UIEvent interface provides specific contextual information associated with User Interface events.

Since:: 1.5, DOM Level 2

Field Summary

Fields declared in interface Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

Modifier and Type	Field	Description
`static final short`	`AT_TARGET`	The event is currently being evaluated at the target `EventTarget`.
`static final short`	`BUBBLING_PHASE`	The current event phase is the bubbling phase.
`static final short`	`CAPTURING_PHASE`	The current event phase is the capturing phase.

Method Summary

Modifier and Type	Method	Description
`int`	`getDetail()`	Specifies some detail information about the `Event`, depending on the type of event.
`AbstractView`	`getView()`	The `view` attribute identifies the `AbstractView` from which the event was generated.
`void`	`initUIEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg)`	The `initUIEvent` method is used to initialize the value of a `UIEvent` created through the `DocumentEvent` interface.

Methods declared in interface Event

getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation

Modifier and Type	Method	Description
`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.
`String`	`getType()`	The name of the event (case-insensitive).
`void`	`initEvent(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.

Method Details

getView

AbstractView getView()

The view attribute identifies the AbstractView from which the event was generated.

getDetail

int getDetail()

Specifies some detail information about the Event, depending on the type of event.

initUIEvent

void initUIEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg)

The initUIEvent method is used to initialize the value of a UIEvent created through the DocumentEvent interface. This method may only be called before the UIEvent 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.

Parameters:: typeArg - 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.; viewArg - Specifies the Event's AbstractView.; detailArg - Specifies the Event's detail.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.