Java example source code file (MutationEvent.java)

This example Java source code file (MutationEvent.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

addition, dom, modification, mutationevent, node, removal, string

The MutationEvent.java Java example source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 in the LICENSE file that
 * accompanied this code).
 *
 * 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * This file is available under and governed by the GNU General Public
 * License version 2 only, as published by the Free Software Foundation.
 * However, the following notice accompanied the original version of this
 * file and, per its terms, should not be removed:
 *
 * 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 <code>MutationEvent interface provides specific contextual
 * information associated with Mutation events.
 * <p>See also the Document Object Model (DOM) Level 2 Events Specification.
 * @since DOM Level 2
 */
public interface MutationEvent extends Event {
    // attrChangeType
    /**
     * The <code>Attr was modified in place.
     */
    public static final short MODIFICATION              = 1;
    /**
     * The <code>Attr was just added.
     */
    public static final short ADDITION                  = 2;
    /**
     * The <code>Attr was just removed.
     */
    public static final short REMOVAL                   = 3;

    /**
     *  <code>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
     * <code>relatedNode is the changed parent. If an event is
     * instead dispatched to a subtree indicating a node was changed within
     * it, the <code>relatedNode is the changed node. In the case of
     * the DOMAttrModified event it indicates the <code>Attr node
     * which was modified, added, or removed.
     */
    public Node getRelatedNode();

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

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

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

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

    /**
     * The <code>initMutationEvent method is used to initialize the
     * value of a <code>MutationEvent created through the
     * <code>DocumentEvent interface. This method may only be called
     * before the <code>MutationEvent has been dispatched via the
     * <code>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 <code>Event's related Node.
     * @param prevValueArg Specifies the <code>Event's
     *   <code>prevValue attribute. This value may be null.
     * @param newValueArg Specifies the <code>Event's
     *   <code>newValue attribute. This value may be null.
     * @param attrNameArg Specifies the <code>Event's
     *   <code>attrName attribute. This value may be null.
     * @param attrChangeArg Specifies the <code>Event's
     *   <code>attrChange attribute
     */
    public void initMutationEvent(String typeArg,
                                  boolean canBubbleArg,
                                  boolean cancelableArg,
                                  Node relatedNodeArg,
                                  String prevValueArg,
                                  String newValueArg,
                                  String attrNameArg,
                                  short attrChangeArg);

}