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.CircularClusterNumber

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

An object that identifies a cluster by a unique integer number.

Method Summary

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

Methods

constructor
ParameterTypeDescription
number
equals
Returns Boolean: 'true' if the cluster numbers are equal and 'false' otherwise.

Compares the ClusterNumber 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 ClusterNumber and the method getNumber() called on it returns the same value as the number attribute of the ClusterNumber.

ParameterTypeDescription
objObjectThe object with which to compare the 'ClusterNumber'
getNumber
Returns int: The number attribute of the cluster identifier.
Returns the number attribute of the cluster identifier.
hashCode
Returns int: a hash code value for the 'ClusterNumber'

Returns a hash code for the ClusterNumber.

toString
Returns String: A string representation of the cluster number.
Returns a string representation of the 'ClusterNumber'.