NodeLayout (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.graph.layout
Interface NodeLayout

All Superinterfaces:: Layout

All Known Implementing Classes:: CircularLayout, EnergyLayout, HierarchicalLayout, OrgChartLayout, RandomLayout, SwimlaneLayout, TreeLayout

public interface NodeLayout
extends Layout

The NodeLayout interface specifies the contract for classes responsible for laying out both node and edge elements of a graph. Client code may selectively add only those nodes and edges that should be positioned by the layout algorithm. The additional minor responsibilities include layout duration estimation, layout progress notification as well as two methods which can be implemented to efficiently allocate memory.

An implementation class should perform its layout using a layout algorithm that arranges nodes and edges according to some conceptual arrangement model.

The Layout classes may be used individually or by a LayoutController. To ensure that a Layout is always used properly, the following process flow is stipulated:

 
    ________________________________________ 
   |   + getLayoutAttributesTemplate        |
   |________________________________________|
   |   _____________________________________|
   |  |  # init                             |
   |  |_____________________________________|
   |  |  #  beforeAddNodeHandler            |
   |  |_____________________________________|
   |  |    _________________________________|
   |  |   |  + addNode                      |
   |  |   |_________________________________|
   |  |_____________________________________|
   |  |  #  beforeAddEdgeHandler            |
   |  |_____________________________________|
   |  |    _________________________________|
   |  |   |  + addEdge                      |
   |  |   |_________________________________|
   |  |_____________________________________|
   |  |   __________________________________|
   |  |  |   +  useAttribute                |
   |  |  |__________________________________|
   |  |  |\  + isGraphSuitable?       __..' |
   |  |  | \                    __..-'      |
   |  |  |  \             __..-'            |
   |  |  |NO \     __..--'      YES         |
   |  |  |____\__'__________________________|
   |  |  |     |+ getEstimatedArrangingTime |
   |  |  |     |____________________________|
   |  |  |     |   _________________________|
   |  |  |     |  | # beforeLayoutHandler   |
   |  |  |     |  | # layout     |
   |  |  |     |  | # afterLayoutHandler    |
   |  |  |     |  |_________________________|
   |  |  |     |  | + getReport()           |
   |  |  |     |  |_________________________|
   |  |  |     |____________________________|
   |  |  |__________________________________|
   |  |_____________________________________|
   |________________________________________|

Version:: $Id: NodeLayout.java,v 1.16 2006/03/14 14:35:25 MichaelKegel Exp $
Author:: Sharokh Khani

Field Summary
`static int`	`DIRECTION_BOTTOM_TO_TOP` constant that tells about the direction of a node layout
`static int`	`DIRECTION_LEFT_TO_RIGHT` constant that tells about the direction of a node layout
`static int`	`DIRECTION_RIGHT_TO_LEFT` constant that tells about the direction of a node layout
`static int`	`DIRECTION_TOP_TO_BOTTOM` constant that tells about the direction of a node layout
`static int`	`DIRECTION_UNDEFINED` constant that tells about the direction of a node layout

Method Summary
`boolean`	`addEdge(LayoutableEdge edge)` This method adds an edge to the layout.
`boolean`	`addNode(LayoutableNode node)` This method adds nodes into the layout classes.
`void`	`beforeAddEdgeHandler(int edgeCount)` This method must be called before inserting edges.
`void`	`beforeAddNodeHandler(int nodeCount)` This method will be triggered before inserting nodes.
`int`	`getDirection()` Returns a constant that represents the direction of the `NodeLayout` implementation.
`AttributeSet`	`getEdgeAttributesTemplate()` Returns the attribute set of edges which is initialized with default values.
`long`	`getEstimatedArrangingTime()` Returns an estimate time for arranging of a given graph.
`AttributeSet`	`getNodeAttributesTemplate()` Returns the attribute set of nodes which is initialized with default values.
`int`	`getPreferEdgeType(AttributeSet usingAttributes)` This method allows a layout classes to inform the caller about it preferred edge type.
`boolean`	`isGraphSuitable()` This method checks whether the layout is able to arrange the visual elements it contains.
`boolean`	`layout(int left, int top, boolean reassignPorts)` Performs the layout process.
`void`	`setProgressBar(LayoutProgress progressBar)` This method might be use to set a progress bar.

Methods inherited from interface com.tensegrity.graph.layout.Layout

afterLayoutHandler, beforeLayoutHandler, error, getErrorMessage, getLayoutAttributesTemplate, getName, getReport, init, updateAttributeSet, useAttribute

Field Detail