001    /*
002     * Copyright (c) 2000 World Wide Web Consortium,
003     * (Massachusetts Institute of Technology, Institut National de
004     * Recherche en Informatique et en Automatique, Keio University). All
005     * Rights Reserved. This program is distributed under the W3C's Software
006     * Intellectual Property License. This program is distributed in the
007     * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
008     * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
009     * PURPOSE.
010     * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
011     */
012    
013    package org.w3c.dom.events;
014    
015    import org.w3c.dom.views.AbstractView;
016    
017    /**
018     * The <code>UIEvent</code> interface provides specific contextual information
019     * associated with User Interface events.
020     * <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>.
021     * @since DOM Level 2
022     */
023    public interface UIEvent extends Event {
024        /**
025         * The <code>view</code> attribute identifies the <code>AbstractView</code>
026         *  from which the event was generated.
027         */
028        public AbstractView getView();
029    
030        /**
031         * Specifies some detail information about the <code>Event</code>,
032         * depending on the type of event.
033         */
034        public int getDetail();
035    
036        /**
037         * The <code>initUIEvent</code> method is used to initialize the value of
038         * a <code>UIEvent</code> created through the <code>DocumentEvent</code>
039         * interface. This method may only be called before the
040         * <code>UIEvent</code> has been dispatched via the
041         * <code>dispatchEvent</code> method, though it may be called multiple
042         * times during that phase if necessary. If called multiple times, the
043         * final invocation takes precedence.
044         * @param typeArg Specifies the event type.
045         * @param canBubbleArg Specifies whether or not the event can bubble.
046         * @param cancelableArg Specifies whether or not the event's default
047         *   action can be prevented.
048         * @param viewArg Specifies the <code>Event</code>'s
049         *   <code>AbstractView</code>.
050         * @param detailArg Specifies the <code>Event</code>'s detail.
051         */
052        public void initUIEvent(String typeArg,
053                                boolean canBubbleArg,
054                                boolean cancelableArg,
055                                AbstractView viewArg,
056                                int detailArg);
057    
058    }