ilog.cpl.graph.graphlayout.css

Class IlpCircularLayoutParameters

java.lang.Object

ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpCircularLayoutParameters

public class IlpCircularLayoutParameters
extends IlpGraphLayoutParameters

This class models the properties that can be configured for each object when using the Circular layout.

To customize per-object properties, the graph layout renderer must be enabled and configured to customize per-object properties.

Since:

JViews 7.5

See Also:

IlvCircularLayout

Constructor Summary

Constructors

Constructor and Description
IlpCircularLayoutParameters() Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	apply(IlvGraphLayout layout, IlpRepresentationObject ro, IlvGraphic layoutProxy) Applies the configuration that is stored in this bean into the given layout for the given node.
IlvClusterId[]	getClusterIds() Returns the cluster identifiers for the clusters to which node belongs.
IlvClusterId	getClusterIds(int index) Returns the cluster identifier of the given index for the cluster to which this node belongs
int[]	getIndex() Returns the index for the node.
int	getIndex(int i) Returns the index to which the node belongs in the unique cluster.
boolean	isStarCenter() Returns if the bean applies to the star center object.
void	reset() Resets the configuration in this bean.
void	setClusterIds(IlvClusterId[] ids) Sets the cluster identifiers to which node belongs.
void	setClusterIds(int index, IlvClusterId id) Allows you to add a cluster identifier id to the list of cluster identifiers to which node belongs.
void	setIndex(int[] values) Allows you to specify that node belongs to a unique cluster of a given identifier id and is associated with the integer value index
void	setIndex(int i, int value) Allows you to specify that node belongs to a unique cluster of a given identifier id and is associated with the integer value index.
void	setStarCenter(boolean flag) Indicates that the object being configured by this bean will become or not the star center in the circular layout.

Methods inherited from class ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

isFixed, isLayoutIgnored, setFixed, setLayoutIgnored

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlpCircularLayoutParameters

public IlpCircularLayoutParameters()

Default constructor

Method Detail

reset

public void reset()

Resets the configuration in this bean.

Overrides:

reset in class IlpGraphLayoutParameters

apply

public boolean apply(IlvGraphLayout layout,
                     IlpRepresentationObject ro,
                     IlvGraphic layoutProxy)

Applies the configuration that is stored in this bean into the given layout for the given node.

Overrides:

apply in class IlpGraphLayoutParameters

Parameters:

layout - Graph Layout

ro - Object to which the configuration will be applied

layoutProxy - Layout graphic object for a node or link

setStarCenter

public void setStarCenter(boolean flag)

Indicates that the object being configured by this bean will become or not the star center in the circular layout.

Parameters:

flag - Start center flag

See Also:

IlvCircularLayout.setStarCenter(java.lang.Object, boolean)

isStarCenter

public boolean isStarCenter()

Returns if the bean applies to the star center object.

Returns:

If the bean is supposed to be a star center

See Also:

IlvCircularLayout.isStarCenter(java.lang.Object)

setClusterIds

public void setClusterIds(IlvClusterId[] ids)

Sets the cluster identifiers to which node belongs.

Parameters:

ids - Cluster identifiers

See Also:

IlvCircularLayout.getClusterIds(java.lang.Object)

setClusterIds

public void setClusterIds(int index,
                          IlvClusterId id)

Allows you to add a cluster identifier id to the list of cluster identifiers to which node belongs.

Parameters:

index - Index

id - Cluster identifier

See Also:

IlvCircularLayout.getClusterIds(java.lang.Object)

getClusterIds

public IlvClusterId[] getClusterIds()

Returns the cluster identifiers for the clusters to which node belongs.

Returns:

Cluster identifiers

See Also:

IlvCircularLayout.getClusterIds(java.lang.Object)

getClusterIds

public IlvClusterId getClusterIds(int index)

Returns the cluster identifier of the given index for the cluster to which this node belongs

Parameters:

index - Index of the cluster identifier being queried.

Returns:

Cluster identifier

See Also:

IlvCircularLayout.getClusterIds(java.lang.Object)

setIndex

public void setIndex(int[] values)

Allows you to specify that node belongs to a unique cluster of a given identifier id and is associated with the integer value index

Parameters:

values - Node index

See Also:

IlvCircularLayout.getIndex(java.lang.Object, ilog.views.graphlayout.circular.IlvClusterId)

setIndex

public void setIndex(int i,
                     int value)

Allows you to specify that node belongs to a unique cluster of a given identifier id and is associated with the integer value index.

Parameters:

i - Index

value - Node index

See Also:

IlvCircularLayout.getIndex(java.lang.Object, ilog.views.graphlayout.circular.IlvClusterId)

getIndex

public int[] getIndex()

Returns the index for the node.

Returns:

Node index

See Also:

IlvCircularLayout.getIndex(java.lang.Object, ilog.views.graphlayout.circular.IlvClusterId)

getIndex

public int getIndex(int i)

Returns the index to which the node belongs in the unique cluster.

Parameters:

i - index

Returns:

Node index

See Also:

IlvCircularLayout.getIndex(java.lang.Object, ilog.views.graphlayout.circular.IlvClusterId)