com.tensegrity.graph.layout.orgchart
Class OrgChartLayoutConstants

java.lang.Object
  extended bycom.tensegrity.graph.layout.orgchart.OrgChartLayoutConstants

public class OrgChartLayoutConstants
extends java.lang.Object

This class contains attributes as well their their default values and is used primarily by class OrgChartLayout

The OrgChartLayout class provides several predefined arrangement styles which are typically used for modeling organization charts. You can use the associated constants to define the default arrangement for the whole graph, or to change the arrangement of nodes that should have a different arrangement style than the default.

The distance between nodes is adjustable. You can use the following attributes to set the distance between them:

The OrgChartLayout class expects a rooted tree as input. However, in some cases it is necessary to show the association between nodes. In this case it is possible to define an edge as an association edge using the following attribute:

Version:
$Id: OrgChartLayoutConstants.java,v 1.38 2006/05/24 18:42:06 SharokhKhani Exp $
Author:
Sharokh Khani

Field Summary
static java.lang.String ARRANGEMENT_DESC
          Specifies the arrangement style for a node.
static java.lang.String CHILDREN_BALANCE_CENTER
          Arranges child nodes balanced / center.
static java.lang.String CHILDREN_BALANCE_LEFT
          Arranges child nodes balanced / left.
static java.lang.String CHILDREN_BALANCE_RIGHT
          Arranges child nodes balanced / right.
static java.lang.String CHILDREN_LIST_DOUBLE
          Arranges child nodes list / double.
static java.lang.String CHILDREN_LIST_LEFT
          Arranges child nodes list / left.
static java.lang.String CHILDREN_LIST_RIGHT
          Arranges child nodes list / right.
static java.lang.String COMPACT
          The arrangement style of the nodes will be set by the OrgChart Layout automatically to achieve a compact diagram. .
static java.lang.String DEFAULT_NODE_ARRANGEMENT_DEF
          The default value for DEFAULT_NODE_ARRANGEMENT_DEF.
static java.lang.String DEFAULT_NODE_ARRANGEMENT_DESC
          The default arrangement style for the whole graph.
static java.lang.String DESCRIPTION_EDGE_CATEGORY
          description text for attributes of edges
static java.lang.String DESCRIPTION_GRAPH_CATEGORY
          description text for attributes of graph
static java.lang.String DESCRIPTION_NODE_CATEGORY
          description text for attributes of nodes
static java.lang.String ERROR_NO_TREE
          Error message.
static boolean FREE_NODE_PLACEMENT_DEF
          An Association edge shows only the association between two nodes and have any effect on their arrangement.
static java.lang.String FREE_NODE_PLACEMENT_DESC
          This attribure determines whether position of nodes before layout should be taken in the consideration or not.
static MetricExpression HORIZONTAL_DISTANCE_DEF
          The default value for HORIZONTAL_DISTANCE_DESC.
static java.lang.String HORIZONTAL_DISTANCE_DESC
          The horizontal distance between nodes.
static java.lang.String LAYOUT_NAME
          Name of this layout class.
static java.lang.String LINK_TYPE_ASSOCIATION
          An Association edge shows only the association between two nodes and have any effect on their arrangement.
static java.lang.String LINK_TYPE_CONNECTOR
          A connector edge connects two nodes and has an effect on their arrangement.
static java.lang.String LINK_TYPE_DESC
          This attribute can be used to specify the edge type.
static java.lang.String NODE_PINNED_DESC
          Determines whether the node is pinned.
static java.lang.String STAFF_ELEMENT
          Arranges nodes as staff elements.
static MetricExpression VERTICAL_DISTANCE_DEF
          The default value for VERTICAL_DISTANCE_DESC.
static java.lang.String VERTICAL_DISTANCE_DESC
          The vertical distance between nodes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LAYOUT_NAME

public static final java.lang.String LAYOUT_NAME
Name of this layout class.

See Also:
Constant Field Values

VERTICAL_DISTANCE_DESC

public static final java.lang.String VERTICAL_DISTANCE_DESC
The vertical distance between nodes.

See Also:
Constant Field Values

VERTICAL_DISTANCE_DEF

public static final MetricExpression VERTICAL_DISTANCE_DEF
The default value for VERTICAL_DISTANCE_DESC.


HORIZONTAL_DISTANCE_DESC

public static final java.lang.String HORIZONTAL_DISTANCE_DESC
The horizontal distance between nodes.

See Also:
Constant Field Values

HORIZONTAL_DISTANCE_DEF

public static final MetricExpression HORIZONTAL_DISTANCE_DEF
The default value for HORIZONTAL_DISTANCE_DESC.


DEFAULT_NODE_ARRANGEMENT_DESC

public static java.lang.String DEFAULT_NODE_ARRANGEMENT_DESC
The default arrangement style for the whole graph. It will be used for all nodes without an own arrangement style. Please use ARRANGEMENT_DESC to assign a node a different arrangement style. null
The following arrangement styles are available: null

See Also:
ARRANGEMENT_DESC

DEFAULT_NODE_ARRANGEMENT_DEF

public static java.lang.String DEFAULT_NODE_ARRANGEMENT_DEF
The default value for DEFAULT_NODE_ARRANGEMENT_DEF.


NODE_PINNED_DESC

public static final java.lang.String NODE_PINNED_DESC
Determines whether the node is pinned.
Pinned nodes will be not arranged.

See Also:
Constant Field Values

ARRANGEMENT_DESC

public static final java.lang.String ARRANGEMENT_DESC
Specifies the arrangement style for a node. Please notice that in case you don't assign a particular arrangement style to a node, the OrgChartLayout will use the default arrangement style for this node. The default arrangement style can be set by DEFAULT_NODE_ARRANGEMENT_DESC. The following arrangement styles are available: null
null

See Also:
Constant Field Values

CHILDREN_BALANCE_CENTER

public static final java.lang.String CHILDREN_BALANCE_CENTER
Arranges child nodes balanced / center.
The child nodes will be divided horizontally below their parent nodes.

See Also:
ARRANGEMENT_DESC, Constant Field Values

CHILDREN_BALANCE_LEFT

public static final java.lang.String CHILDREN_BALANCE_LEFT
Arranges child nodes balanced / left.
The child nodes will be divided horizontally below their parent nodes so that the first child node is below the parent node.

See Also:
ARRANGEMENT_DESC, Constant Field Values

CHILDREN_BALANCE_RIGHT

public static final java.lang.String CHILDREN_BALANCE_RIGHT
Arranges child nodes balanced / right.
The child nodes will be divided horizontally below their parent node so that the last child node is below the parent node.

See Also:
ARRANGEMENT_DESC, Constant Field Values

CHILDREN_LIST_LEFT

public static final java.lang.String CHILDREN_LIST_LEFT
Arranges child nodes list / left.
The children will be arranged one below the other, and on the right side of the parent center point.

See Also:
ARRANGEMENT_DESC, Constant Field Values

CHILDREN_LIST_RIGHT

public static final java.lang.String CHILDREN_LIST_RIGHT
Arranges child nodes list / right.
The children will be arranged one below the other, and on the left side of the parent center point.

See Also:
ARRANGEMENT_DESC, Constant Field Values

CHILDREN_LIST_DOUBLE

public static final java.lang.String CHILDREN_LIST_DOUBLE
Arranges child nodes list / double.
The children will be arranged one below the other divided equally on the left and right side of the parent center point.

See Also:
ARRANGEMENT_DESC, Constant Field Values

STAFF_ELEMENT

public static final java.lang.String STAFF_ELEMENT
Arranges nodes as staff elements.
The staff elements will be distributed under the parent node vertically and divided on the left and right side of the parent center point horizontally.
Notice:

See Also:
ARRANGEMENT_DESC, Constant Field Values

COMPACT

public static final java.lang.String COMPACT
The arrangement style of the nodes will be set by the OrgChart Layout automatically to achieve a compact diagram. .

See Also:
ARRANGEMENT_DESC, Constant Field Values

FREE_NODE_PLACEMENT_DESC

public static final java.lang.String FREE_NODE_PLACEMENT_DESC
This attribure determines whether position of nodes before layout should be taken in the consideration or not. If true the user can influence the order of the nodes using mouse.

See Also:
Constant Field Values

FREE_NODE_PLACEMENT_DEF

public static final boolean FREE_NODE_PLACEMENT_DEF
An Association edge shows only the association between two nodes and have any effect on their arrangement.

See Also:
LINK_TYPE_DESC, Constant Field Values

LINK_TYPE_DESC

public static final java.lang.String LINK_TYPE_DESC
This attribute can be used to specify the edge type. null
The edge type can be one of the following: null Notice: Each node-pair can be connected by maximum one connector edge but by an unlimited number of association edges.

See Also:
Constant Field Values

LINK_TYPE_CONNECTOR

public static final java.lang.String LINK_TYPE_CONNECTOR
A connector edge connects two nodes and has an effect on their arrangement. The connected nodes will be arranged immediately after each other.
Notice: This is the default edge type.

See Also:
LINK_TYPE_DESC, Constant Field Values

LINK_TYPE_ASSOCIATION

public static final java.lang.String LINK_TYPE_ASSOCIATION
An Association edge shows only the association between two nodes and have any effect on their arrangement.

See Also:
LINK_TYPE_DESC, Constant Field Values

DESCRIPTION_GRAPH_CATEGORY

public static final java.lang.String DESCRIPTION_GRAPH_CATEGORY
description text for attributes of graph

See Also:
Constant Field Values

DESCRIPTION_NODE_CATEGORY

public static final java.lang.String DESCRIPTION_NODE_CATEGORY
description text for attributes of nodes

See Also:
Constant Field Values

DESCRIPTION_EDGE_CATEGORY

public static final java.lang.String DESCRIPTION_EDGE_CATEGORY
description text for attributes of edges

See Also:
Constant Field Values

ERROR_NO_TREE

public static final java.lang.String ERROR_NO_TREE
Error message.

See Also:
Constant Field Values


Copyright © 2005 Tensegrity Software GmbH. All Rights Reserved. Date of creation: 09.06.2006.