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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The newest version!

/*
 * Copyright (c) 2000 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. 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 W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.w3c.dom.events;

import org.w3c.dom.Node;

/**
 * The MutationEvent interface provides specific contextual 
 * information associated with Mutation events. 
 * See also the Document Object Model (DOM) Level 2 Events Specification.
 * @since DOM Level 2
 */
public interface MutationEvent extends Event {
    // attrChangeType
    /**
     * The Attr was modified in place.
     */
    public static final short MODIFICATION              = 1;
    /**
     * The Attr was just added.
     */
    public static final short ADDITION                  = 2;
    /**
     * The Attr was just removed.
     */
    public static final short REMOVAL                   = 3;

    /**
     *  relatedNode is used to identify a secondary node related 
     * to a mutation event. For example, if a mutation event is dispatched 
     * to a node indicating that its parent has changed, the 
     * relatedNode is the changed parent. If an event is 
     * instead dispatched to a subtree indicating a node was changed within 
     * it, the relatedNode is the changed node. In the case of 
     * the DOMAttrModified event it indicates the Attr node 
     * which was modified, added, or removed. 
     */
    public Node getRelatedNode();

    /**
     *  prevValue indicates the previous value of the 
     * Attr node in DOMAttrModified events, and of the 
     * CharacterData node in DOMCharacterDataModified events. 
     */
    public String getPrevValue();

    /**
     *  newValue indicates the new value of the Attr 
     * node in DOMAttrModified events, and of the CharacterData 
     * node in DOMCharacterDataModified events. 
     */
    public String getNewValue();

    /**
     *  attrName indicates the name of the changed 
     * Attr node in a DOMAttrModified event. 
     */
    public String getAttrName();

    /**
     *  attrChange indicates the type of change which triggered 
     * the DOMAttrModified event. The values can be MODIFICATION
     * , ADDITION, or REMOVAL. 
     */
    public short getAttrChange();

    /**
     * The initMutationEvent method is used to initialize the 
     * value of a MutationEvent created through the 
     * DocumentEvent interface. This method may only be called 
     * before the MutationEvent has been dispatched via the 
     * dispatchEvent method, though it may be called multiple 
     * times during that phase if necessary. If called multiple times, the 
     * final invocation takes precedence.
     * @param typeArg Specifies the event type.
     * @param canBubbleArg Specifies whether or not the event can bubble.
     * @param cancelableArg Specifies whether or not the event's default 
     *   action can be prevented.
     * @param relatedNodeArg Specifies the Event's related Node.
     * @param prevValueArg Specifies the Event's 
     *   prevValue attribute. This value may be null.
     * @param newValueArg Specifies the Event's 
     *   newValue attribute. This value may be null.
     * @param attrNameArg Specifies the Event's 
     *   attrName attribute. This value may be null.
     * @param attrChangeArg Specifies the Event's 
     *   attrChange attribute
     */
    public void initMutationEvent(String typeArg, 
                                  boolean canBubbleArg, 
                                  boolean cancelableArg, 
                                  Node relatedNodeArg, 
                                  String prevValueArg, 
                                  String newValueArg, 
                                  String attrNameArg, 
                                  short attrChangeArg);

}