01: /*
02: * $Id: JGraphEditorDiagram.java,v 1.1.1.1 2005/08/04 11:21:58 gaudenz Exp $
03: * Copyright (c) 2001-2005, Gaudenz Alder
04: *
05: * All rights reserved.
06: *
07: * See LICENSE file for license details. If you are unable to locate
08: * this file please contact info (at) jgraph (dot) com.
09: */
10: package com.jgraph.editor;
11:
12: import java.util.Map;
13:
14: import javax.swing.tree.MutableTreeNode;
15:
16: import org.jgraph.graph.GraphLayoutCache;
17:
18: /**
19: * Defines the basic requirements for a named diagram in a JGraph editor
20: * document model. A diagram contains a (stateful) layout cache with a graph
21: * model. The properties of document model elements should be changed via the
22: * document model in order to update all attached listeners.
23: */
24: public interface JGraphEditorDiagram extends MutableTreeNode {
25:
26: /**
27: * Sets the name.
28: *
29: * @param name
30: * The name to set.
31: */
32: public void setName(String name);
33:
34: /**
35: * Returns the name.
36: *
37: * @return Returns the name.
38: */
39: public String getName();
40:
41: /**
42: * @param cache
43: * The cache to set.
44: */
45: public void setGraphLayoutCache(GraphLayoutCache cache);
46:
47: /**
48: * @return Returns the cache.
49: */
50: public GraphLayoutCache getGraphLayoutCache();
51:
52: /**
53: * Returns the properties of the diagram.
54: *
55: * @return Returns all properties.
56: */
57: public Map getProperties();
58:
59: }
|