org.w3c.dom.events.CustomEvent Maven / Gradle / Ivy
/*
* Portions Copyright 2000-2008 Sun Microsystems, Inc. All Rights
* Reserved. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version
* 2 only, as published by the Free Software Foundation.
*
* This program is distributed 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. See the GNU
* General Public License version 2 for more details (a copy is
* included at /legal/license.txt).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*/
/*
* 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;
/**
* The CustomEvent interface is the recommended interface for
* application-specific event types. Unlike the Event
* interface, it allows applications to provide contextual information about
* the event type. Application-specific event types should have an
* associated namespace to avoid clashes with future general-purpose event
* types.
* To create an instance of the CustomEvent interface, use
* the DocumentEvent.createEvent("CustomEvent") method call.
*
See also the
*
* Document Object Model (DOM) Level 3 Events Specification.
*
* @since DOM Level 3
*/
public interface CustomEvent extends Event {
/**
* Specifies some detail information about the Event.
*/
public Object getDetail();
/**
* The initCustomEventNS method is used to initialize the
* value of a CustomEvent object and has the same behavior
* as Event.initEventNS().
* @param namespaceURIArg 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 detailArg Specifies CustomEvent.detail. This
* value may be null.
*/
public void initCustomEventNS(String namespaceURIArg,
String typeArg,
boolean canBubbleArg,
boolean cancelableArg,
Object detailArg);
}