org.cruxframework.crux.core.client.html5.api

Class MutationObserver

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.cruxframework.crux.core.client.html5.api.MutationObserver

public class MutationObserver
extends com.google.gwt.core.client.JavaScriptObject

MutationObserver provides developers a way to react to changes in a DOM. It is designed as a replacement for Mutation Events defined in the DOM3 Events specification.

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MutationObserver.Callback Define an handler for mutations observed.
static interface	MutationObserver.LoadCallback Interface used to load a new MutationObserver object.
static class	MutationObserver.MutationRecord MutationRecord is the object that will be passed to the observer's callback.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutationObserver() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected static MutationObserver	create(MutationObserver.Callback callback)
void	disconnect() Stops the MutationObserver instance from receiving notifications of DOM mutations.
static boolean	isSupported() Verify if the current browser supports the MutationObserver API.
static void	load(MutationObserver.Callback callback, MutationObserver.LoadCallback loadCallback) If current browser supports the MutationObserver API, create a new Observer.
void	observe(com.google.gwt.dom.client.Node node, boolean children, boolean attributes, boolean characterData) Observe the given node for modifications Adding an observer to an element is just like addEventListener, if you observe the element multiple times it does not make a difference.
void	observeAttributes(com.google.gwt.dom.client.Node node) Observe the given node for modifications on its attributes.
void	observeChildren(com.google.gwt.dom.client.Node node) Observe the given node for modifications on its children.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MutationObserver

protected MutationObserver()

Default constructor

Method Detail

disconnect

public final void disconnect()

Stops the MutationObserver instance from receiving notifications of DOM mutations. Until the observe() method is used again, observer's callback will not be invoked.

observe

public final void observe(com.google.gwt.dom.client.Node node,
           boolean children,
           boolean attributes,
           boolean characterData)

Observe the given node for modifications Adding an observer to an element is just like addEventListener, if you observe the element multiple times it does not make a difference. Meaning if you observe element twice, the observe callback does not fire twice, nor will you have to run disconnect() twice. In other words, once an element is observed, observing it again with the same observer instance will do nothing. However if the callback object is different it will of course add another observer to it.

Parameters:

node - the node to be monitored.

children - if true, start monitoring changes on children list.

attributes - if true, start monitoring changes on node attributes.

characterData - if true, start monitoring changes on node data.

observeAttributes

public final void observeAttributes(com.google.gwt.dom.client.Node node)

Observe the given node for modifications on its attributes.

Parameters:

node - the node to be monitored.

observeChildren

public final void observeChildren(com.google.gwt.dom.client.Node node)

Observe the given node for modifications on its children.

Parameters:

node - the node to be monitored.

isSupported

public static boolean isSupported()

Verify if the current browser supports the MutationObserver API.

Returns:

true if supported.

load

public static void load(MutationObserver.Callback callback,
        MutationObserver.LoadCallback loadCallback)

If current browser supports the MutationObserver API, create a new Observer.

Parameters:

callback - A handler for the mutations.

create

protected static MutationObserver create(MutationObserver.Callback callback)