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-2007 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.sql.framework.ui.graph;
043:
044: import java.util.Collection;
045: import java.util.List;
046:
047: import javax.swing.Action;
048:
049: /**
050: * @author radval
051: */
052: public interface IGraphView extends ICommand {
053:
054: /**
055: * add a IGraphNode
056: *
057: * @param node IGraphNode
058: */
059: public void addNode(IGraphNode node);
060:
061: /**
062: * Remove an IGraphNode
063: *
064: * @param node IGraphNode
065: */
066: public void removeNode(IGraphNode node);
067:
068: /**
069: * add a link
070: *
071: * @param from IGraphPort
072: * @param to IGraphPort
073: */
074: public void addLink(IGraphPort from, IGraphPort to);
075:
076: /**
077: * add a graph link
078: *
079: * @param link graph link
080: */
081: public void addLink(IGraphLink link);
082:
083: /**
084: * Remove a link
085: *
086: * @param from IGraphPort
087: * @param to IGraphPort
088: */
089: public void removeLink(IGraphPort from, IGraphPort to);
090:
091: /**
092: * set the graph controller on this view
093: *
094: * @param controller graph controller
095: */
096: public void setGraphController(IGraphController controller);
097:
098: /**
099: * get the graph controller of this view
100: *
101: * @return graph controller
102: */
103: public IGraphController getGraphController();
104:
105: /**
106: * Expand all the graph objects
107: */
108: public void expandAll();
109:
110: /**
111: * collapse all the graph objects
112: */
113: public void collapseAll();
114:
115: /**
116: * autolayout all the graph objects
117: */
118: public void autoLayout();
119:
120: /**
121: * delete a graph node
122: *
123: * @param node graph node
124: */
125: public void deleteNode(IGraphNode node);
126:
127: /**
128: * delete a collection of links
129: */
130: public void deleteLinks(Collection links);
131:
132: /**
133: * get graph view manager which can manage this view
134: *
135: * @return graph view manager
136: */
137: public Object getGraphViewContainer();
138:
139: /**
140: * set the graph view manager which this view can refer to
141: *
142: * @param mgr graph view manager
143: */
144: public void setGraphViewContainer(Object mgr);
145:
146: /**
147: * Print the view
148: */
149: public void printView();
150:
151: /**
152: * set the graph model
153: *
154: * @param model graph model
155: */
156: public void setGraphModel(Object model);
157:
158: /**
159: * get graph model
160: *
161: * @return graph model
162: */
163: public Object getGraphModel();
164:
165: /**
166: * get the graph actions that need to be shown in popup menu
167: *
168: * @return a list of GraphAction, null in list represents a seperator
169: */
170: public List getGraphActions();
171:
172: /**
173: * set graph actions on this view
174: *
175: * @param actions list of GraphAction
176: */
177: public void setGraphActions(List actions);
178:
179: /**
180: * can this graph be edited
181: *
182: * @return true if graph is edited
183: */
184: public boolean canEdit();
185:
186: /**
187: * set the graph factory which is used for creating nodes in this graph
188: *
189: * @param gFactory graph node factory
190: */
191: public void setGraphFactory(Object gFactory);
192:
193: /**
194: * get the graph factory
195: *
196: * @return graph factory
197: */
198: public Object getGraphFactory();
199:
200: /**
201: * get a action based on class name
202: *
203: * @param actionClass
204: * @return action
205: */
206: public Action getAction(Class actionClass);
207:
208: /**
209: * set the toolbar
210: *
211: * @param toolBar
212: */
213: public void setToolBar(IToolBar toolBar);
214:
215: /**
216: * get the toolbar
217: *
218: * @return toolbar
219: */
220: public IToolBar getToolBar();
221:
222: /**
223: * remove all the view and document objects
224: */
225: public void clearAll();
226:
227: /**
228: * set this graph view modifiable
229: *
230: * @param b modifiable
231: */
232: public void setModifiable(boolean b);
233:
234: /**
235: * check if this graph view is modifiable
236: *
237: * @return modifiable
238: */
239: public boolean isModifiable();
240:
241: /**
242: * Execute a command
243: *
244: * @param command - command
245: * @param args - arguments
246: */
247: public void execute(String command, Object[] args);
248:
249: public IGraphNode findGraphNode(Object obj);
250:
251: /**
252: * Reset selection colors
253: */
254: public void resetSelectionColors();
255:
256: /**
257: * Highlight invalid graph node
258: *
259: * @param dataObj data object whose graph node needs to be highlighted
260: * @param createSel if true will create a new selection otherwise add the graph node
261: * to existing selection
262: */
263: public void highlightInvalidNode(Object dataObj, boolean createSel);
264:
265: public void clearSelection();
266:
267: public void setXMLInfo(IOperatorXmlInfo xmlInfo);
268: }
|