1 /* 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 * 4 * This code is free software; you can redistribute it and/or modify it 5 * under the terms of the GNU General Public License version 2 only, as 6 * published by the Free Software Foundation. Oracle designates this 7 * particular file as subject to the "Classpath" exception as provided 8 * by Oracle in the LICENSE file that accompanied this code. 9 * 10 * This code is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * version 2 for more details (a copy is included in the LICENSE file that 14 * accompanied this code). 15 * 16 * You should have received a copy of the GNU General Public License version 17 * 2 along with this work; if not, write to the Free Software Foundation, 18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 * 20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 * or visit www.oracle.com if you need additional information or have any 22 * questions. 23 */ 24 25 /* 26 * This file is available under and governed by the GNU General Public 27 * License version 2 only, as published by the Free Software Foundation. 28 * However, the following notice accompanied the original version of this 29 * file and, per its terms, should not be removed: 30 * 31 * Copyright (c) 2000 World Wide Web Consortium, 32 * (Massachusetts Institute of Technology, Institut National de 33 * Recherche en Informatique et en Automatique, Keio University). All 34 * Rights Reserved. This program is distributed under the W3C's Software 35 * Intellectual Property License. This program is distributed in the 36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even 37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 38 * PURPOSE. 39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 40 */ 41 42 package org.w3c.dom.events; 43 44 import org.w3c.dom.DOMException; 45 46 /** 47 * The <code>DocumentEvent</code> interface provides a mechanism by which the 48 * user can create an Event of a type supported by the implementation. It is 49 * expected that the <code>DocumentEvent</code> interface will be 50 * implemented on the same object which implements the <code>Document</code> 51 * interface in an implementation which supports the Event model. 52 * <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>. 53 * @since DOM Level 2 54 */ 55 public interface DocumentEvent { 56 /** 57 * 58 * @param eventType The <code>eventType</code> parameter specifies the 59 * type of <code>Event</code> interface to be created. If the 60 * <code>Event</code> interface specified is supported by the 61 * implementation this method will return a new <code>Event</code> of 62 * the interface type requested. If the <code>Event</code> is to be 63 * dispatched via the <code>dispatchEvent</code> method the 64 * appropriate event init method must be called after creation in 65 * order to initialize the <code>Event</code>'s values. As an example, 66 * a user wishing to synthesize some kind of <code>UIEvent</code> 67 * would call <code>createEvent</code> with the parameter "UIEvents". 68 * The <code>initUIEvent</code> method could then be called on the 69 * newly created <code>UIEvent</code> to set the specific type of 70 * UIEvent to be dispatched and set its context information.The 71 * <code>createEvent</code> method is used in creating 72 * <code>Event</code>s when it is either inconvenient or unnecessary 73 * for the user to create an <code>Event</code> themselves. In cases 74 * where the implementation provided <code>Event</code> is 75 * insufficient, users may supply their own <code>Event</code> 76 * implementations for use with the <code>dispatchEvent</code> method. 77 * @return The newly created <code>Event</code> 78 * @exception DOMException 79 * NOT_SUPPORTED_ERR: Raised if the implementation does not support the 80 * type of <code>Event</code> interface requested 81 */ 82 public Event createEvent(String eventType) 83 throws DOMException; 84 85 }