001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.xml.xam;
043:
044: import java.beans.PropertyChangeListener;
045: import javax.swing.event.UndoableEditListener;
046:
047: /**
048: * Interface describing an abstract model. The model is based on a
049: * document representation that represents the persistent form.
050: * @author Chris Webster
051: * @author Nam Nguyen
052: * @author Rico Cruz
053: */
054: public interface Model<C extends Component<C>> extends Referenceable {
055: public static final String STATE_PROPERTY = "state";
056:
057: /**
058: * Add coarse-grained change listener for events on model components.
059: */
060: public void removeComponentListener(ComponentListener cl);
061:
062: /**
063: * Remove component event listener.
064: */
065: public void addComponentListener(ComponentListener cl);
066:
067: /**
068: * Add fine-grained property change listener for events on model components.
069: */
070: public void addPropertyChangeListener(PropertyChangeListener pcl);
071:
072: /**
073: * Remove property change listener.
074: */
075: public void removePropertyChangeListener(PropertyChangeListener pcl);
076:
077: /**
078: * Removes undoable edit listener.
079: */
080: void removeUndoableEditListener(UndoableEditListener uel);
081:
082: /**
083: * Adds undoable edit listener.
084: */
085: void addUndoableEditListener(UndoableEditListener uel);
086:
087: /**
088: * Removes undoable refactoring edit listener. This will also restored
089: * the existing undoable edit listeners to the set before the start of
090: * refactoring. Note, if these listeners are UndoManager instances
091: * their queues are cleared of existing edits.
092: */
093: void removeUndoableRefactorListener(UndoableEditListener uel);
094:
095: /**
096: * Adds undoable refactoring edit listener. This is typically called by a
097: * refactoring manager before start refactoring changes. This
098: * will also save existing undoable edit listeners. Note, if these listeners
099: * are UndoManager instances, their queues will be cleared of existing edits.
100: */
101: void addUndoableRefactorListener(UndoableEditListener uel);
102:
103: /**
104: * make the current memory model consistent with the underlying
105: * representation, typically a swing document.
106: */
107: void sync() throws java.io.IOException;
108:
109: /**
110: * return true if sync is being performed.
111: */
112: boolean inSync();
113:
114: /**
115: * State of the model.
116: * VALID - Source is well-formed and model is in-sync.
117: * NOT_WELL_FORMED - Source is not well-formed, model is not synced.
118: * NOT_SYNCED - Source is well-formed, but there was error from last sync.
119: */
120: enum State {
121: VALID, NOT_WELL_FORMED, NOT_SYNCED
122: }
123:
124: /**
125: * @return the last known state of the document. This method is affected
126: * by invocations of #sync().
127: */
128: State getState();
129:
130: /**
131: * @return true if model is in middle of transformation tranasction.
132: */
133: boolean isIntransaction();
134:
135: /**
136: * This method will block until a transaction can be started. A transaction
137: * in this context will fire events (such as property change) when
138: * #endTransaction() has been invoked. A transaction must be
139: * be acquired during a mutation, reading can be performed without
140: * a transaction. Only a single transaction at a time is supported. Mutations
141: * which occur based on events will not be reflected until the transaction
142: * has completed.
143: * @return true if transaction is acquired successfully, else false, for example
144: * if model has transitioned into invalid state.
145: */
146: boolean startTransaction();
147:
148: /**
149: * This method stops the transaction and causes all events to be fired.
150: * After all events have been fired, the document representation will be
151: * modified to reflect the current value of the model (flush).
152: */
153: void endTransaction();
154:
155: /**
156: * Add child component at specified index.
157: * @param target the parent component.
158: * @param child the child component to be added.
159: * @param index position among same type of child components, or -1 if not relevant.
160: */
161: void addChildComponent(Component target, Component child, int index);
162:
163: /**
164: * Remove specified component from model.
165: */
166: void removeChildComponent(Component child);
167:
168: /**
169: * @return the source of this model or null if this model does associate
170: * with any model source.
171: */
172: ModelSource getModelSource();
173:
174: }
|