org.apache.batik.w3c.dom.events.CustomEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.fop Show documentation
The core maven build properties
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.apache.batik.w3c.dom.events;

import org.w3c.dom.events.Event;

/**
 *  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. 
     */
    Object getDetail();

    /**
     *  The initCustomEventNS method is used to initialize the 
     * value of a CustomEvent 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 detailArg  Specifies CustomEvent.detail. This 
     *   value may be null.   
     */
    void initCustomEventNS(String namespaceURI,
                           String typeArg,
                           boolean canBubbleArg,
                           boolean cancelableArg,
                           Object detailArg);

}