001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package com.sun.perseus.model;
028:
029: import java.io.InputStream;
030:
031: /**
032: * An <code>UpdateListener</code> implementation is responsible for handling
033: * updates to a <code>ModelNode</code> tree and to take appropriate actions,
034: * like collecting dirty state, dirty area or triggering repaint events.
035: *
036: * @version $Id: UpdateListener.java,v 1.3 2006/04/21 06:39:51 st125089 Exp $
037: */
038: public interface UpdateListener {
039: /**
040: * Invoked when a node's rendering is about to be modified
041: *
042: * @param node the node which is about to be modified
043: */
044: void modifyingNodeRendering(ModelNode node);
045:
046: /**
047: * Invoked when a node has been inserted into the tree
048: *
049: * @param node the newly inserted node
050: */
051: void nodeInserted(ModelNode node);
052:
053: /**
054: * Invoked when a node is about to be modified
055: *
056: * @param node the node which is about to be modified
057: */
058: void modifyingNode(ModelNode node);
059:
060: /**
061: * Invoked when a node modification completed
062: *
063: * @param node the node which was modified
064: */
065: void modifiedNode(ModelNode node);
066:
067: /**
068: * Invoked when the input node has finished loading.
069: *
070: * @param node the <code>ModelNode</code> for which loading
071: * is complete.
072: */
073: void loadComplete(ModelNode node);
074:
075: /**
076: * Invoked when the input node has started loading
077: *
078: * @param node the <code>ModelNode</code> for which loading
079: * has started.
080: */
081: void loadBegun(ModelNode node);
082:
083: /**
084: * Invoked when a string has been appended, during a load
085: * phase. This is only used when parsing a document and is
086: * used in support of progressive download, like the other
087: * loadXXX methods.
088: *
089: * @param node the <code>ModelNode</code> on which text has been
090: * inserted.
091: */
092: void textInserted(ModelNode node);
093:
094: /**
095: * Invoked when a document error happened before finishing loading.
096: *
097: * @param documentNode the <code>DocumentNode</code> for which loading
098: * has failed.
099: * @param error the exception which describes the reason why loading
100: * failed.
101: */
102: void loadingFailed(DocumentNode documentNode, Exception error);
103:
104: /**
105: * Invoked when the document starts loading
106: *
107: * @param documentNode the <code>DocumentNode</code> for which loading
108: * is starting
109: * @param is the <code>InputStream</code> from which SVG content
110: * is loaded.
111: */
112: void loadStarting(DocumentNode documentNode, InputStream is);
113: }
|