Source for org.w3c.dom.events.UIEvent

   1: /*
   2:  * Copyright (c) 2000 World Wide Web Consortium,
   3:  * (Massachusetts Institute of Technology, Institut National de
   4:  * Recherche en Informatique et en Automatique, Keio University). All
   5:  * Rights Reserved. This program is distributed under the W3C's Software
   6:  * Intellectual Property License. This program is distributed in the
   7:  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8:  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9:  * PURPOSE.
  10:  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11:  */
  12: 
  13: package org.w3c.dom.events;
  14: 
  15: import org.w3c.dom.views.AbstractView;
  16: 
  17: /**
  18:  * The <code>UIEvent</code> interface provides specific contextual information 
  19:  * associated with User Interface events.
  20:  * <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>.
  21:  * @since DOM Level 2
  22:  */
  23: public interface UIEvent extends Event {
  24:     /**
  25:      * The <code>view</code> attribute identifies the <code>AbstractView</code>
  26:      *  from which the event was generated.
  27:      */
  28:     public AbstractView getView();
  29: 
  30:     /**
  31:      * Specifies some detail information about the <code>Event</code>, 
  32:      * depending on the type of event.
  33:      */
  34:     public int getDetail();
  35: 
  36:     /**
  37:      * The <code>initUIEvent</code> method is used to initialize the value of 
  38:      * a <code>UIEvent</code> created through the <code>DocumentEvent</code> 
  39:      * interface. This method may only be called before the 
  40:      * <code>UIEvent</code> has been dispatched via the 
  41:      * <code>dispatchEvent</code> method, though it may be called multiple 
  42:      * times during that phase if necessary. If called multiple times, the 
  43:      * final invocation takes precedence.
  44:      * @param typeArg Specifies the event type.
  45:      * @param canBubbleArg Specifies whether or not the event can bubble.
  46:      * @param cancelableArg Specifies whether or not the event's default 
  47:      *   action can be prevented.
  48:      * @param viewArg Specifies the <code>Event</code>'s 
  49:      *   <code>AbstractView</code>.
  50:      * @param detailArg Specifies the <code>Event</code>'s detail.
  51:      */
  52:     public void initUIEvent(String typeArg, 
  53:                             boolean canBubbleArg, 
  54:                             boolean cancelableArg, 
  55:                             AbstractView viewArg, 
  56:                             int detailArg);
  57: 
  58: }