ilog.views.gantt.graphic

Class IlvActivityLogisticLayout

java.lang.Object

ilog.views.gantt.graphic.IlvActivitySimpleLayout

ilog.views.gantt.graphic.IlvActivityLogisticLayout

All Implemented Interfaces:

IlvActivityLayout

public class IlvActivityLogisticLayout
extends IlvActivitySimpleLayout

An IlvActivityLogisticLayout is designed to arrange concurrent activities in a Gantt row. It tries to find the best layout for all activities in a Gantt row so that none of them are hidden.

Since:

JViews 6.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASCADE The activity graphics are arranged in cascade.
static int	PRETTY The activity graphics are firstly sorted by the start time of their associated activity and then arranged in cascade.
static int	TILE Deprecated. Beginning with Rogue Wave JViews 6.5, use an instance of IlvActivityTileLayout instead.

Fields inherited from class ilog.views.gantt.graphic.IlvActivitySimpleLayout

DEFAULT_VERTICAL_MARGIN

Constructor Summary

Constructors

Constructor and Description
IlvActivityLogisticLayout(int layoutMode) Creates a new IlvActivityLogisticLayout.
IlvActivityLogisticLayout(int layoutMode, double topMargin, double bottomMargin) Creates a new IlvActivityLogisticLayout.

Method Summary

Modifier and Type	Method and Description
void	arrange(IlvGanttRow row, IlvActivityGraphic graphic) This method is called to layout the position of a single activity graphic within a row.
void	arrange(IlvGanttRow row, IlvActivityGraphic[] graphics) This method is called to layout the position of all the activity graphics within a row.
int	getArrangeMode() Returns the arrange mode.
double	getCascadeOffset() Returns the vertical cascade offset used in CASCADE and PRETTY layout modes.
void	setArrangeMode(int layoutMode) Sets the arrange mode.
void	setCascadeOffset(double offset) Sets the vertical cascade offset used in CASCADE and PRETTY layout modes.

Methods inherited from class ilog.views.gantt.graphic.IlvActivitySimpleLayout

getBottomMargin, getChannelVerticalBounds, getTopMargin, setBottomMargin, setTopMargin

Methods inherited from class java.lang.Object

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

Field Detail

CASCADE

public static final int CASCADE

The activity graphics are arranged in cascade.

See Also:

getArrangeMode(), Constant Field Values

PRETTY

public static final int PRETTY

The activity graphics are firstly sorted by the start time of their associated activity and then arranged in cascade.

See Also:

getArrangeMode(), Constant Field Values

TILE

@Deprecated
public static final int TILE

Deprecated. Beginning with Rogue Wave JViews 6.5, use an instance of IlvActivityTileLayout instead.

The activity graphics to be tiled.

See Also:

getArrangeMode(), Constant Field Values

Constructor Detail

IlvActivityLogisticLayout

public IlvActivityLogisticLayout(int layoutMode,
                                 double topMargin,
                                 double bottomMargin)

Creates a new IlvActivityLogisticLayout.

Parameters:

layoutMode - The layout mode that must be one of CASCADE, PRETTY, or TILE.

topMargin - The top row margin.

bottomMargin - The bottom row margin.

IlvActivityLogisticLayout

public IlvActivityLogisticLayout(int layoutMode)

Creates a new IlvActivityLogisticLayout.

Parameters:

layoutMode - The layout mode that must be one of CASCADE, PRETTY, or TILE.

Method Detail

getArrangeMode

public int getArrangeMode()

Returns the arrange mode. The value is one of CASCADE, PRETTY, or TILE.

See Also:

setArrangeMode(int)

setArrangeMode

public void setArrangeMode(int layoutMode)

Sets the arrange mode.

Parameters:

layoutMode - The layout mode that must be one of CASCADE, PRETTY, or TILE.

See Also:

getArrangeMode()

getCascadeOffset

public double getCascadeOffset()

Returns the vertical cascade offset used in CASCADE and PRETTY layout modes. The default value is 5.0.

See Also:

setCascadeOffset(double)

setCascadeOffset

public void setCascadeOffset(double offset)

Sets the vertical cascade offset used in CASCADE and PRETTY layout modes.

See Also:

getCascadeOffset()

arrange

public void arrange(IlvGanttRow row,
                    IlvActivityGraphic[] graphics)

This method is called to layout the position of all the activity graphics within a row. This method should set the definition rectangle of each activity graphic and can optionally rearrange their drawing order.

Specified by:

arrange in interface IlvActivityLayout

Overrides:

arrange in class IlvActivitySimpleLayout

Parameters:

row - The Gantt row that contains the graphics.

graphics - The array of activity graphics in the row. The ordering of the graphics in the array indicates the z-order in which the activity graphics draw. Graphics at a higher index in the array are drawn after graphics at a lower index. This method can rearrange the graphics within the array to change their drawing order.

arrange

public void arrange(IlvGanttRow row,
                    IlvActivityGraphic graphic)

This method is called to layout the position of a single activity graphic within a row. This method should set the definition rectangle of the activity graphic and can optionally rearrange its drawing order.

Specified by:

arrange in interface IlvActivityLayout

Overrides:

arrange in class IlvActivitySimpleLayout

Parameters:

row - The Gantt row that contains the graphic.

graphic - The activity graphic to be arranged.