ilog.views.gantt.graphic

Class IlvActivitySimpleLayout

java.lang.Object

ilog.views.gantt.graphic.IlvActivitySimpleLayout

All Implemented Interfaces:

IlvActivityLayout

Direct Known Subclasses:

IlvActivityLogisticLayout, IlvActivityTileLayout

public class IlvActivitySimpleLayout
extends Object
implements IlvActivityLayout

IlvSimpleActivityLayout is a basic implementation of IlvActivityLayout that arranges all activity graphics in a row to the full height of the row, minus some vertical margins. This activity layout does not establish any specific drawing z-order for the graphics. Therefore, if you have concurrent tasks in a Gantt row, they will overlap.

Being simple and fast, this layout strategy is suitable to arrange activity graphics in an activity oriented Gantt chart.

Since:

JViews 6.0

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_VERTICAL_MARGIN The default vertical margins of 2.

Constructor Summary

Constructors

Constructor and Description
IlvActivitySimpleLayout() Creates an IlvActivitySimpleLayout with default top and bottom row margins of 2.
IlvActivitySimpleLayout(double topMargin, double bottomMargin) Creates an IlvActivitySimpleLayout with the specified vertical row margins.

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.
double	getBottomMargin() Returns the bottom row margin of the activity layout.
protected IlvRect	getChannelVerticalBounds(IlvGanttRow row) Returns the vertical bounds of the specified row available for arranging its activity graphics.
double	getTopMargin() Returns the top row margin of the activity layout.
void	setBottomMargin(double bottomMargin) Sets the bottom row margin of the activity layout.
void	setTopMargin(double topMargin) Sets the top row margin of the activity layout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERTICAL_MARGIN

public static final double DEFAULT_VERTICAL_MARGIN

The default vertical margins of 2.

Since:

JViews 6.5

See Also:

Constant Field Values

Constructor Detail

IlvActivitySimpleLayout

public IlvActivitySimpleLayout(double topMargin,
                               double bottomMargin)

Creates an IlvActivitySimpleLayout with the specified vertical row margins.

Parameters:

topMargin - The top row margin.

bottomMargin - The bottom row margin.

IlvActivitySimpleLayout

public IlvActivitySimpleLayout()

Creates an IlvActivitySimpleLayout with default top and bottom row margins of 2.

Method Detail

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 implementation arranges the activity graphics to the full height of the row, minus the top margin and the bottom margin. This activity layout does not establish any specific drawing z-order for the graphics.

If you want to implement a z-ordering strategy, you can override this method like this:

 public void arrange(IlvGanttRow row, IlvActivityGraphic[] graphics) {
   // Set the definition rectangle of each activity graphic.
   super.arrange(row, graphics);
   // Set the graphics z-order to match that of the activity start times.
   Arrays.sort(graphics, new Comparator<IlvActivityGraphic>() {
     public int compare(IlvActivityGraphic o1, IlvActivityGraphic o2) {
       Date start1 = o1.getActivity().getStartTime();
       Date start2 = o2.getActivity().getStartTime();
       return start1.compareTo(start2);
     }
   });
 }
 

Specified by:

arrange in interface IlvActivityLayout

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. Typically, this occurs when an activity has been newly inserted into or assigned to an already existing row. This activity layout does not establish any specific drawing z-order for the graphics. If you want to implement a z-ordering strategy, you should implement the draw ordering in the arrange(IlvGanttRow, IlvActivityGraphic[]) method. Then override this method to delegate like this:

 public void arrange(IlvGanttRow row, IlvActivityGraphic graphic) {
   // Relayout the entire row so that z-ordering is respected between all graphics.
   arrange(row, row.getActivityGraphics());
 }
 

Specified by:

arrange in interface IlvActivityLayout

Parameters:

row - The Gantt row that contains the graphic.

graphic - The activity graphic to be arranged.

getTopMargin

public double getTopMargin()

Returns the top row margin of the activity layout.

Returns:

The top margin.

setTopMargin

public void setTopMargin(double topMargin)

Sets the top row margin of the activity layout.

Parameters:

topMargin - The top margin.

getBottomMargin

public double getBottomMargin()

Returns the bottom row margin of the activity layout.

Returns:

The bottom margin.

setBottomMargin

public void setBottomMargin(double bottomMargin)

Sets the bottom row margin of the activity layout.

Parameters:

bottomMargin - The bottom margin.

getChannelVerticalBounds

protected IlvRect getChannelVerticalBounds(IlvGanttRow row)

Returns the vertical bounds of the specified row available for arranging its activity graphics. This will be the vertical bounds of the row after subtracting the top and bottom margins of the layout.

Parameters:

row - The Gantt row.

Returns:

The vertical y-axis bounds available to arrange graphics within the row, specified by the y and height fields of the rectangle. The x axis dimension of the rectangle can be ignored.