org.w3c.dom.events.UIEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of batik Show documentation
An Apache Batik Maven port to be pushed in Maven Central repo.
The newest version!
/*
 * Copyright (c) 2006 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] 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.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom.events;

import org.w3c.dom.views.AbstractView;

/**
 *  The UIEvent interface provides specific contextual 
 * information associated with User Interface events. 
 *  To create an instance of the UIEvent interface, use the 
 * DocumentEvent.createEvent("UIEvent") method call. 
 * See also the 
   Document Object Model (DOM) Level 3 Events Specification
  .
 * @since DOM Level 2
 */
public interface UIEvent extends Event {
    /**
     *  The view attribute identifies the 
     * AbstractView from which the event was generated. 
     */
    public AbstractView getView();

    /**
     *  Specifies some detail information about the Event, 
     * depending on the type of event. 
     */
    public int getDetail();

    /**
     *  The initUIEvent method is used to initialize the value of 
     * a UIEvent object and has the same behavior as 
     * Event.initEvent(). 
     * @param typeArg  Refer to the Event.initEvent() method for 
     *   a description of this parameter. 
     * @param canBubbleArg  Refer to the Event.initEvent() 
     *   method for a description of this parameter. 
     * @param cancelableArg  Refer to the Event.initEvent() 
     *   method for a description of this parameter. 
     * @param viewArg  Specifies UIEvent.view. This value may be 
     *   null. 
     * @param detailArg  Specifies UIEvent.detail.   
     */
    public void initUIEvent(String typeArg, 
                            boolean canBubbleArg, 
                            boolean cancelableArg, 
                            AbstractView viewArg, 
                            int detailArg);

    /**
     *  The initUIEventNS method is used to initialize the value 
     * of a UIEvent object and has the same behavior as 
     * Event.initEventNS(). 
     * @param namespaceURI  Refer to the Event.initEventNS() 
     *   method for a description of this parameter. 
     * @param typeArg  Refer to the Event.initEventNS() method 
     *   for a description of this parameter. 
     * @param canBubbleArg  Refer to the Event.initEventNS() 
     *   method for a description of this parameter. 
     * @param cancelableArg  Refer to the Event.initEventNS() 
     *   method for a description of this parameter. 
     * @param viewArg  Refer to the UIEvent.initUIEvent() method 
     *   for a description of this parameter. 
     * @param detailArg  Refer to the UIEvent.initUIEvent() 
     *   method for a description of this parameter.   
     * @since DOM Level 3
     */
    public void initUIEventNS(String namespaceURI, 
                              String typeArg, 
                              boolean canBubbleArg, 
                              boolean cancelableArg, 
                              AbstractView viewArg, 
                              int detailArg);

}