Simple viewer for Graphvizable. More...

Collaboration diagram for aud.util.DotViewer:

Public Member Functions
	DotViewer (JFrame parent)
	create new instance More...

JFrame	parent ()
	get parent widget More...

JLabel	statusbar ()
	get status bar More...

void	display (String code)
	display dot code More...

void	display (Graphvizable object)
	display `object` More...

void	setExitOnClose ()
	exit application if viewer is closed More...

Static Public Member Functions
static void	help ()
	print help (mouse/key bindings) to stdout More...

static DotViewer	displayWindow (Graphvizable object, String caption)
	create new DotViewer (toplevel window) and display `object` More...

static DotViewer	displayWindow (String code, String caption)
	create new DotViewer (toplevel window) and display `code` More...

static void	main (String[] args)
	visualize given dot files (file names as command line arguments) More...

Protected Member Functions
JComponent	createComponents ()

Protected Attributes
File	dotfile

JFrame	frame

JSVGCanvas	svgCanvas

Graphviz	graphviz

JLabel	label

Detailed Description

Simple viewer for Graphvizable.

Based on Batik's SVGCanvas.

Usage:

Shift+Mouse Left = pan
Shift+Mouse Right (drag) = zoom in/out
Ctrl+Mouse Left = rectangle zoom
Ctrl+Mouse Right (drag) = rotate [disabled]
Ctrl+I = zoom in
Ctrl+O = zoom out

DotViewer can be used with SingleStepper to visualize progress of an algorithm. GraphDemo shows an example.

See also: SingleStepper

TODO: link GraphDemo

Definition at line 48 of file DotViewer.java.

Constructor & Destructor Documentation

◆ DotViewer()

aud.util.DotViewer.DotViewer ( JFrame parent )

create new instance

Definition at line 57 of file DotViewer.java.

                                  {
    frame=parent;
    svgCanvas=new JSVGCanvas();
    svgCanvas.setEnableRotateInteractor(false);//
 
    label=new JLabel();
    parent.getContentPane().add(createComponents());
 
    try {
      dotfile=File.createTempFile("aud-dotviewer-",".dot");
    } catch (IOException e) {
      System.err.println("ERROR: "+e.getMessage());
      System.exit(-1);
    }
    //System.err.println(dotfile);
    graphviz=new Graphviz();
    dotfile.deleteOnExit();
  }

References aud.util.DotViewer.createComponents(), aud.util.DotViewer.dotfile, aud.util.DotViewer.frame, aud.util.DotViewer.graphviz, aud.util.DotViewer.label, aud.util.DotViewer.parent(), and aud.util.DotViewer.svgCanvas.

Here is the call graph for this function:

Member Function Documentation

◆ createComponents()

JComponent aud.util.DotViewer.createComponents ( )

protected

Definition at line 81 of file DotViewer.java.

                                          {
    final JPanel panel = new JPanel(new BorderLayout());
    @SuppressWarnings("unused")
    final JSVGScrollPane pane = new JSVGScrollPane(svgCanvas);
 
    panel.add("Center", svgCanvas);
    panel.add("South", label);
    return panel;
  }

References aud.util.DotViewer.label, and aud.util.DotViewer.svgCanvas.

Referenced by aud.util.DotViewer.DotViewer().

Here is the caller graph for this function:

◆ display() [1/2]

void aud.util.DotViewer.display ( Graphvizable object )

display object

Definition at line 135 of file DotViewer.java.

                                           {
    display(object.toDot());
  }

References aud.util.DotViewer.display().

Here is the call graph for this function:

◆ display() [2/2]

void aud.util.DotViewer.display ( String code )

display dot code

See also: Graphviz

Definition at line 108 of file DotViewer.java.

                                   {
    Sys.writeToFile(dotfile,code);
    //System.err.println(dotfile);
    File svgfile=graphviz.renderDotFileToFile(dotfile,"svg");
    //svgfile.deleteOnExit();
    //svgCanvas.setURI(svgfile.toURI().toString());
 
    Path path=FileSystems.getDefault().getPath(svgfile.getPath());
 
    try {
      String data=new String(Files.readAllBytes(path));
      data=data.replaceAll("stroke=\"transparent\"","stroke-opacity=\"0\"");
 
      String parser=XMLResourceDescriptor.getXMLParserClassName();
      SAXSVGDocumentFactory factory=new SAXSVGDocumentFactory(parser);
      SVGDocument document=
          factory.createSVGDocument("",new ByteArrayInputStream(data.getBytes("UTF-8")));
      svgCanvas.setDocument(document);
    } catch (IOException e) {
      System.err.println(e);
      System.exit(-1);
    }
 
    svgfile.delete();
  }

References aud.util.DotViewer.dotfile, aud.util.DotViewer.graphviz, aud.util.Graphviz.renderDotFileToFile(), aud.util.DotViewer.svgCanvas, and aud.util.Sys.writeToFile().

Referenced by aud.util.DotViewer.display(), aud.util.DotViewer.displayWindow(), aud.example.A234TreeExample.onHalt(), aud.example.AVLTreeExample.onHalt(), aud.example.BinarySearchTreeExample.onHalt(), aud.example.BinaryTreeTraversal.onHalt(), aud.example.BTreeExample.onHalt(), aud.example.expr.ExpressionTreeTraversal.onHalt(), aud.example.RedBlackTreeExample.onHalt(), and aud.util.SingleStepperDemo.onHalt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayWindow() [1/2]

static DotViewer aud.util.DotViewer.displayWindow	(	Graphvizable	object,
		String	caption
	)

static

create new DotViewer (toplevel window) and display object

Definition at line 140 of file DotViewer.java.

                                                                            {
    return displayWindow(object.toDot(),caption);
  }

References aud.util.DotViewer.displayWindow().

Referenced by aud.util.Graphviz.display(), aud.util.DotViewer.displayWindow(), and aud.util.DotViewer.main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayWindow() [2/2]

static DotViewer aud.util.DotViewer.displayWindow	(	String	code,
		String	caption
	)

static

create new DotViewer (toplevel window) and display code

Definition at line 144 of file DotViewer.java.

                                                                    {
    JFrame f=new JFrame(caption!=null ? caption : "aud.util.DotViewer");
    DotViewer dot=new DotViewer(f);
    f.setSize(800, 600);
    f.setVisible(true);
    if (code!=null)
      dot.display(code);
    return dot;
  }

References aud.util.DotViewer.display().

Here is the call graph for this function:

◆ help()

static void aud.util.DotViewer.help ( )

static

print help (mouse/key bindings) to stdout

Definition at line 92 of file DotViewer.java.

                            {
    System.out.println
    ( "Batik JSVGCanvas overview\n"+
        "-------------------------\n"+
        "Shift+Mouse Left\tpan\n"+
        "Shift+Mouse Right\tzoom in/out (drag)\n"+
        "Ctrl+Mouse Left\trectangle zoom\n"+
        "Ctrl+Mouse Right\trotate [disabled!]\n"+
        "Ctrl+I\tzoom in\n"+
        "Ctrl+O\tzoom out\n"
    );
  }

Referenced by aud.util.DotViewer.main().

Here is the caller graph for this function:

◆ main()

static void aud.util.DotViewer.main ( String[] args )

static

visualize given dot files (file names as command line arguments)

Definition at line 164 of file DotViewer.java.

                                         {
    if (args.length==0) {
      System.err.println("usage: java aud.util.DotViewer file.dot\n");
      DotViewer.help();
    }
    else
      for (String arg : args) {
        String dotCode=Sys.readFile(new File(arg));
        DotViewer v=DotViewer.displayWindow(dotCode,arg);
        v.setExitOnClose();
      }
  }

References aud.util.DotViewer.displayWindow(), aud.util.DotViewer.help(), aud.util.Sys.readFile(), and aud.util.DotViewer.setExitOnClose().

Here is the call graph for this function:

◆ parent()

JFrame aud.util.DotViewer.parent ( )

get parent widget

Definition at line 77 of file DotViewer.java.

77{ return frame; }

References aud.util.DotViewer.frame.

Referenced by aud.util.DotViewer.DotViewer(), and aud.util.DotViewer.setExitOnClose().

Here is the caller graph for this function:

◆ setExitOnClose()

void aud.util.DotViewer.setExitOnClose ( )

exit application if viewer is closed

Definition at line 155 of file DotViewer.java.

                               {
    parent().addWindowListener(new WindowAdapter() {
      public void windowClosing(WindowEvent e) {
        System.exit(0);
      }
    });
  }