src/bind/java/org/w3c/dom/events/UIEvent.java

   1 /*
   2  * Copyright (c) 2003 World Wide Web Consortium,
   3  *
   4  * (Massachusetts Institute of Technology, European Research Consortium for
   5  * Informatics and Mathematics, Keio University). All Rights Reserved. This
   6  * work is distributed under the W3C(r) Software License [1] in the hope that
   7  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
   8  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   9  *
  10  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
  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
  19  * information associated with User Interface events.
  20  * <p> To create an instance of the <code>UIEvent</code> interface, use the
  21  * <code>DocumentEvent.createEvent("UIEvent")</code> method call.
  22  * <p>See also the <a href='http://www.w3.org/TR/2003/NOTE-DOM-Level-3-Events-20031107'>Document Object Model (DOM) Level 3 Events Specification</a>.
  23  * @since DOM Level 2
  24  */
  25 public interface UIEvent extends Event {
  26     /**
  27      * The <code>view</code> attribute identifies the <code>AbstractView</code>
  28      *  from which the event was generated.
  29      */
  30     public AbstractView getView();
  31
  32     /**
  33      * Specifies some detail information about the <code>Event</code>,
  34      * depending on the type of event.
  35      */
  36     public int getDetail();
  37
  38     /**
  39      *  The <code>initUIEvent</code> method is used to initialize the value of
  40      * a <code>UIEvent</code> object and has the same behavior as
  41      * <code>Event.initEvent()</code>.
  42      * @param typeArg  Refer to the <code>Event.initEvent()</code> method for
  43      *   a description of this parameter.
  44      * @param canBubbleArg  Refer to the <code>Event.initEvent()</code>
  45      *   method for a description of this parameter.
  46      * @param cancelableArg  Refer to the <code>Event.initEvent()</code>
  47      *   method for a description of this parameter.
  48      * @param viewArg Specifies <code>UIEvent.view</code>.
  49      * @param detailArg Specifies <code>UIEvent.detail</code>.
  50      */
  51     public void initUIEvent(String typeArg,
  52                             boolean canBubbleArg,
  53                             boolean cancelableArg,
  54                             AbstractView viewArg,
  55                             int detailArg);
  56
  57     /**
  58      *  The <code>initUIEventNS</code> method is used to initialize the value
  59      * of a <code>UIEvent</code> object and has the same behavior as
  60      * <code>Event.initEventNS()</code>.
  61      * @param namespaceURI  Refer to the <code>Event.initEventNS()</code>
  62      *   method for a description of this parameter.
  63      * @param typeArg  Refer to the <code>Event.initEventNS()</code> method
  64      *   for a description of this parameter.
  65      * @param canBubbleArg  Refer to the <code>Event.initEventNS()</code>
  66      *   method for a description of this parameter.
  67      * @param cancelableArg  Refer to the <code>Event.initEventNS()</code>
  68      *   method for a description of this parameter.
  69      * @param viewArg  Refer to the <code>UIEvent.initUIEvent()</code> method
  70      *   for a description of this parameter.
  71      * @param detailArg  Refer to the <code>UIEvent.initUIEvent()</code>
  72      *   method for a description of this parameter.
  73      * @since DOM Level 3
  74      */
  75     public void initUIEventNS(String namespaceURI,
  76                               String typeArg,
  77                               boolean canBubbleArg,
  78                               boolean cancelableArg,
  79                               AbstractView viewArg,
  80                               int detailArg);
  81
  82 }