ilog.cpl.graph.graphlayout.css

Class IlpGridLayoutParameters

java.lang.Object

ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpGridLayoutParameters

public class IlpGridLayoutParameters
extends IlpGraphLayoutParameters

This class models the properties that can be configured for each object when using the Grid 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:

IlvGridLayout

Constructor Summary

Constructors

Constructor and Description
IlpGridLayoutParameters() 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.
int	getHorizontalAlignment() Returns the horizontal alignment style of an individual node.
int	getIndex() Returns the index of a node.
int	getVerticalAlignment() Returns the vertical alignment style of an individual node.
void	reset() Resets the configuration in this bean.
void	setHorizontalAlignment(int align) Sets the horizontal alignment style of an individual node.
void	setIndex(int i) Allows you to specify the index of a node.
void	setVerticalAlignment(int align) Sets the vertical alignment style of an individual node.

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

IlpGridLayoutParameters

public IlpGridLayoutParameters()

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

setIndex

public void setIndex(int i)

Allows you to specify the index of a node. When the layout is performed, the nodes for which indexes have been specified are arranged on the bus in the order corresponding to their index (starting in the upper-left corner with the smallest index). The nodes for which indexes have not been specified are arranged after them. You can specify the class variable IlvBusLayout.NO_INDEX as an index value if you want to reset an index you previously specified.

Note that index must not be negative. The values of the indexes for consecutive nodes are not necessarily consecutive. Only the order of the values is important.

Parameters:

i - Node index

See Also:

IlvGridLayout.setIndex(java.lang.Object, int)

getIndex

public int getIndex()

Returns the index of a node.

Returns:

The node index

See Also:

setIndex(int)

setVerticalAlignment

public void setVerticalAlignment(int align)

Sets the vertical alignment style of an individual node.

This alignment style is used only if the global vertical alignment is set to IlvGridLayout.MIXED. Otherwise, all nodes have the alignment style that is specified as the global alignment style.

The parameter controls the vertical alignment of nodes either inside their grid cell if the layout mode (see IlvGridLayout.setLayoutMode(int)) is IlvGridLayout.TILE_TO_GRID_FIXED_WIDTH or IlvGridLayout.TILE_TO_GRID_FIXED_HEIGHT, or inside the rows if the layout mode is IlvGridLayout.TILE_TO_ROWS.

This parameter is not used if the layout mode (see IlvGridLayout.setLayoutMode(int)) is IlvGridLayout.TILE_TO_COLUMNS.

Valid values are:

• IlvGridLayout.CENTER - the node is centered in its grid cell or column.
• IlvGridLayout.TOP - the node is aligned to the top border of the cell or column.
• IlvGridLayout.BOTTOM - the node is aligned to the bottom border of the cell or column.

The default value is IlvGridLayout.CENTER.

Parameters:

align - Vertical alignment style for this node

See Also:

IlvGridLayout.setVerticalAlignment(java.lang.Object, int)

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment style of an individual node.

Returns:

The vertical alignment style for a given node

See Also:

setVerticalAlignment(int)

setHorizontalAlignment

public void setHorizontalAlignment(int align)

Sets the horizontal alignment style of an individual node.

This alignment style is used only if the global horizontal alignment is set to IlvGridLayout.MIXED. Otherwise, all nodes have the alignment style that is specified as the global alignment style.

The parameter controls the horizontal alignment of nodes either inside their grid cell if the layout mode (see IlvGridLayout.setLayoutMode(int)) is IlvGridLayout.TILE_TO_GRID_FIXED_WIDTH or IlvGridLayout.TILE_TO_GRID_FIXED_HEIGHT, or inside the columns if the layout mode is IlvGridLayout.TILE_TO_COLUMNS

This parameter is not used if the layout mode (see IlvGridLayout.setLayoutMode(int)) is IlvGridLayout.TILE_TO_ROWS.

Valid values are:

• IlvGridLayout.CENTER - the node is centered in its grid cell or column.
• IlvGridLayout.LEFT - the node is aligned to the left border of the cell or column.
• IlvGridLayout.RIGHT - the node is aligned to the left border of the cell or column.

The default value is IlvGridLayout.CENTER.

Parameters:

align - Horizontal alignment style for this node

See Also:

IlvGridLayout.setHorizontalAlignment(java.lang.Object, int)

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment style of an individual node.

Returns:

The horizontal alignment style for a given node

See Also:

setVerticalAlignment(int)