ilog.cpl.graph.graphlayout.css
Class IlpGraphLayoutParameters

java.lang.Object
  ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

Direct Known Subclasses:

IlpAbstractLinkLayoutParameters, IlpBusLayoutParameters, IlpCircularLayoutParameters, IlpGridLayoutParameters, IlpHierarchicalLayoutParameters, IlpTreeLayoutParameters, IlpUniformLengthEdgesLayoutParameters

public class IlpGraphLayoutParameters
extends Object

This class models the Java Bean used to configure per-object properties that are valid to all graph layouts.

Since:

JViews 7.5

See Also:

IlvGraphLayout

Constructor Summary

IlpGraphLayoutParameters()
Default constructor

Method Summary

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.
boolean	isFixed() Allows you to specify whether a node or a link is fixed.
boolean	isLayoutIgnored() Indicates if the node or link should be ignored by this graph or link layout.
void	reset() Resets the configuration in this bean.
void	setFixed(boolean fix) Allows you to specify whether a node or a link is fixed.
void	setLayoutIgnored(boolean ignore) Allows you to specify whether a node or a link shall be ignored by the graph layout.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpGraphLayoutParameters

public IlpGraphLayoutParameters()

Default constructor

Method Detail

reset

public void reset()

Resets the configuration in this bean.

If you are subclassing this class or one of its subclasses, you must always call the superclass reset method, as illustrated below:

 public void reset() {
   super.reset();
   // Then add below the code to reset your new properties
 }
 

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.

If you are subclassing this class or one of its subclasses, you must always call the superclass apply method, as illustrated below:

 public void apply (...) {
   super.apply(...);
   // Then add below the code to set your new properties
 }
 

Parameters:

layout - Graph Layout

ro - Object to which the configuration will be applied

layoutProxy - Layout graphic object for a node or link

setFixed

public void setFixed(boolean fix)

Allows you to specify whether a node or a link is fixed. Fixed nodes are not moved during the layout only if the method IlvGraphLayout.isPreserveFixedNodes() returns true.

By default, no node is fixed.

Fixed links are not reshaped during the layout only if the method IlvGraphLayout.isPreserveFixedLinks() returns true. By default, no link is fixed.

Parameters:

fix - Indicates if the node or link shall be fixed

isFixed

public boolean isFixed()

Allows you to specify whether a node or a link is fixed. Fixed nodes are not moved during the layout only if the method IlvGraphLayout.isPreserveFixedNodes() returns true.

By default, no node is fixed.

Fixed links are not reshaped during the layout only if the method IlvGraphLayout.isPreserveFixedLinks() returns true. By default, no link is fixed.

Returns:

If the node or link is fixed

setLayoutIgnored

public void setLayoutIgnored(boolean ignore)

Allows you to specify whether a node or a link shall be ignored by the graph layout.

If this property is set to true, the object will be completely ignored by the graph model (using an IlvLayoutGraphicFilter).

Parameters:

ignore - Indicates if the object will be ignored or node

isLayoutIgnored

public boolean isLayoutIgnored()

Indicates if the node or link should be ignored by this graph or link layout.

Returns:

If the node or link shall be ignored by the layout.