Perforce JViews Diagrammer Code Example: Hierarchical Layout (Java SDK Version)

Description

This sample shows how to use the Hierarchical Layout algorithm in a Java application. It shows how to perform a Hierarchical Layout and how to control its layout parameters in Java code. This sample uses the graphic framework, but it does not use the IlvDiagrammer component or CSS.

A version of the Hierarchical Layout sample that uses CSS can be found <A HREF="../css/index.html">here</A>

How to Use the Code Example

The Hierarchical Layout algorithm can be used to lay out a directed graph. It arranges the nodes in horizontal or vertical levels and routes the links in a uniform direction. The algorithm takes into account several justification options, link styles (selectable for individual links), and level arrangement options. Furthermore, it supports port specifications where links connect at the nodes, layout constraints, and many more features. Not all features are shown in this simple sample.
This application shows a manager view that displays a grapher read from an IVL file. You may change the grapher sample using the list at the top of the application.
The application also has interactor buttons on the top side: pan, select, zoom box, zoom in, zoom out, and show all (fit to contents).
On the bottom, there are two buttons: Random (performs a Random Layout) and Layout (uses the Hierarchical Layout algorithm). Layout is only performed when you press these buttons.
Under the buttons, there are choice menus that allow you to select the flow direction of the majority of links and the global link style. You may also change the minimal offsets between nodes, between a node and a link bend, and between links. For details, see the corresponding section of the User's Manual.
The port samples look best in the orthogonal link style.
The status line at the bottom displays a message indicating which action was performed. During layout, the status line shows the percentage of the layout task that is already completed.

How to Run the Code Example as an Application

This code example can be run as an application. The installation directory contains an executable JAR file, hierarchicallayout.jar, that allows you to execute the code example with a double click from a file browser. Note that if you are using Internet Explorer, you can open the installation directory and execute the JAR file from the browser. This technique may not work in other Web browsers.

Alternatively, you can run the code example application from the command line. First check that the Ant utility is properly configured. If not, see the instructions on how to configure Ant for Perforce JViews.

Then, go to the installation directory of the code example and type:

ant run

Topics Covered

Grapher
Graph Layout
Hierarchical Layout in Java Code
Hierarchical Layout Parameters

Installation Directory

The Hierarchical Layout (Java SDK Version) code example is installed here.

Classes Involved

Source Files

HierarchicalLayoutApp