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.circular.CircularClusterName

Object » ibm_ilog.graphlayout.circular.CircularClusterId » ibm_ilog.graphlayout.circular.CircularClusterName
dojo.require("ibm_ilog.graphlayout.circular.CircularClusterName");

An object that is used to identify a cluster by a unique name (a string).

Method Summary

  • constructor(name)
  • equals(obj) returns Boolean Compares the 'ClusterName' to the specified object.
  • getName() returns String Returns the name attribute of the cluster identifier.
  • hashCode() Returns a hash code for the 'ClusterName'.
  • toString() returns String Returns a string representation of the 'ClusterName'.

Methods

constructor
ParameterTypeDescription
name
equals
Returns Boolean: 'true' if the 'ClusterName' are equal; 'false' otherwise.

Compares the ClusterName to the specified object. The result is true if and only if the argument is not null, and if the argument is an instance of ClusterName and the method getName() called on it returns the same string as the name attribute of the ClusterName.

ParameterTypeDescription
objObjectThe object with which to compare the 'ClusterName'
getName
Returns String: The name of the cluster.
Returns the name attribute of the cluster identifier.
hashCode
a hash code value for the 'ClusterName'

Returns a hash code for the ClusterName.

toString
Returns String: The cluster name as a string.
Returns a string representation of the 'ClusterName'.