/*
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.events;

import org.w3c.dom.views.AbstractView;

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

See also the Document Object Model (DOM) Level 2 Events Specification.

Since:DOM Level 2
/** * The <code>UIEvent</code> interface provides specific contextual information * associated with User Interface events. * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113'>Document Object Model (DOM) Level 2 Events Specification</a>. * @since DOM Level 2 */
public interface UIEvent extends Event {
The view attribute identifies the AbstractView from which the event was generated.
/** * The <code>view</code> attribute identifies the <code>AbstractView</code> * from which the event was generated. */
public AbstractView getView();
Specifies some detail information about the Event, depending on the type of event.
/** * Specifies some detail information about the <code>Event</code>, * depending on the type of event. */
public int getDetail();
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.
Params:
  • 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.
/** * The <code>initUIEvent</code> method is used to initialize the value of * a <code>UIEvent</code> created through the <code>DocumentEvent</code> * interface. This method may only be called before the * <code>UIEvent</code> has been dispatched via the * <code>dispatchEvent</code> method, though it may be called multiple * times during that phase if necessary. If called multiple times, the * final invocation takes precedence. * @param typeArg Specifies the event type. * @param canBubbleArg Specifies whether or not the event can bubble. * @param cancelableArg Specifies whether or not the event's default * action can be prevented. * @param viewArg Specifies the <code>Event</code>'s * <code>AbstractView</code>. * @param detailArg Specifies the <code>Event</code>'s detail. */
public void initUIEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg); }