/*
* $Id$
*
@Copyright (c) 1998-2005 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the
above copyright notice and the following two paragraphs appear in all
copies of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package diva.graph.tutorial;
import java.awt.GridLayout;
import javax.swing.SwingUtilities;
import diva.graph.GraphPane;
import diva.graph.JGraph;
import diva.graph.MutableGraphModel;
import diva.graph.basic.BasicGraphController;
import diva.graph.basic.BasicGraphModel;
import diva.graph.basic.BasicLayoutTarget;
import diva.graph.layout.IncrLayoutAdapter;
import diva.graph.layout.IncrementalLayoutListener;
import diva.graph.layout.LevelLayout;
import diva.graph.layout.RandomLayout;
import diva.graph.modular.CompositeNode;
import diva.graph.modular.Edge;
import diva.graph.modular.Node;
import diva.gui.AppContext;
import diva.gui.BasicFrame;
/**
* This example shows three alternatives to display a prepopulated
* graph model in a window. Prepopulated means that there are
* already nodes in the model before the model was placed in a
* GraphPane. There was a problem in the initial release which made
* this break. That problem has been fixed and it will just work now,
* except for one little gotcha, which is if you set the model while
* the window is closed, the GraphPane thinks its size is 0x0, so the
* nodes all get layed out in the upper-left corner of the canvas. The
* way to fix this is to either set the model once the window is open,
* or explicitly call a global layout once the window has been opened.
* More comments below in the individual methods.
*
* @author Michael Shilman
* @version $Id$
* @Pt.AcceptedRating Red
*/
public class PrepopulatedTutorial {
public static void main(String[] argv) {
final AppContext context = new BasicFrame("Prepopulated Tutorial");
context.setSize(300, 600);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
new PrepopulatedTutorial(context);
context.setVisible(true);
}
});
}
private PrepopulatedTutorial(AppContext context) {
// Construct the prepopulated model
//
// A
// / \
// B C
//
BasicGraphModel model = new BasicGraphModel();
CompositeNode root = (CompositeNode) model.getRoot();
Node a = model.createNode("a");
Node b = model.createNode("b");
Node c = model.createNode("c");
model.addNode(this, a, root);
model.addNode(this, b, root);
model.addNode(this, c, root);
Edge x = model.createEdge("x");
Edge y = model.createEdge("y");
model.connectEdge(this, x, a, b);
model.connectEdge(this, y, a, c);
// Display the model in three
// different panes, using three
// different techniques.
try {
context.getContentPane().setLayout(new GridLayout(3, 1));
bogusLayout(model, context);
layoutPostDisplay(model, context);
setModelPostDisplay(model, context);
} catch (Exception ex) {
ex.printStackTrace();
System.exit(0);
}
}
/**
* This is the first thing you'd probably think of, but this
* happens to be bogus, because the layout
* is applied to the nodes before the window is showing,
* meaning that the nodes are layed out in a 0x0 frame,
* and are all clustered in the upper-left corner. This
* is remedied in the other techniques given below.
*/
public void bogusLayout(MutableGraphModel model, AppContext context) {
BasicGraphController gc = new BasicGraphController();
context.getContentPane().add(new JGraph(new GraphPane(gc, model)));
RandomLayout random = new RandomLayout(new BasicLayoutTarget(gc));
random.layout(model.getRoot());
}
/**
* In this version you construct the graph widget with
* the model, and apply a layout to the graph once
* the window is showing. I think the "set model
* post display" version is preferable, but this might
* be useful in some cases.
*/
public void layoutPostDisplay(final MutableGraphModel model,
AppContext context) {
final BasicGraphController bgc = new BasicGraphController();
context.getContentPane().add(new JGraph(new GraphPane(bgc, model)));
SwingUtilities.invokeLater(new Runnable() {
public void run() {
RandomLayout random = new RandomLayout(new BasicLayoutTarget(
bgc));
random.layout(model.getRoot());
}
});
}
/**
* In this version you construct the graph widget with
* the default constructor (giving it an empty graph),
* and then set the model once the window is showing.
*/
public void setModelPostDisplay(MutableGraphModel model, AppContext context) {
BasicGraphController gc = new BasicGraphController();
gc.addGraphViewListener(new IncrementalLayoutListener(
new IncrLayoutAdapter(
new LevelLayout(new BasicLayoutTarget(gc))), null));
context.getContentPane().add(new JGraph(new GraphPane(gc, model)));
}
}