IBM ILOG Dojo Diagrammer 1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.graphlayout.hierarchical.HierarchicalNodeGroup (version 1.1-SNAPSHOT)

Object » ibm_ilog.graphlayout.hierarchical.HierarchicalNodeGroup
dojo.require("ibm_ilog.graphlayout.hierarchical.HierarchicalNodeGroup");

The class NodeGroup allows to create a group of nodes that is subject to a constraint.

A node group itself is not a constraint. But some constraints allow node groups as input rather than single nodes. For instance, it is possible to force a group of nodes to be placed in a higher level than another group of nodes. Or it is possible to force all nodes of the group to be placed no more than a certain number of levels apart.

Property Summary

Method Summary

  • add(node) Adds a node to the node group.
  • constructor(a0)
  • contains(node) returns Boolean Returns 'true' if the node belongs to this group.
  • elements() returns ibm_ilog.graphlayout.IIterator Returns the nodes in the node group.
  • remove(node) Removes a node from the node group.
  • size() returns int Returns the number of nodes in the node group.

Properties

serialVersionUID

Methods

add

Adds a node to the node group.

ParameterTypeDescription
nodeObjectThe node instance.
constructor
ParameterTypeDescription
a0
contains
Returns Boolean: 'true' if the node belongs to this group.
Returns 'true' if the node belongs to this group.
ParameterTypeDescription
nodeObjectThe node instance.
elements
Returns ibm_ilog.graphlayout.IIterator: The nodes in the node group.
Returns the nodes in the node group.
remove

Removes a node from the node group.

ParameterTypeDescription
nodeObjectThe node instance.
size
Returns int: The number of nodes in this group.
Returns the number of nodes in the node group.