ilog.views.gantt.graphic.grid

Class IlvVerticalGanttGrid

java.lang.Object

ilog.views.gantt.graphic.grid.IlvAbstractGanttGrid

ilog.views.gantt.graphic.grid.IlvVerticalGanttGrid

All Implemented Interfaces:

IlvGanttGridRenderer

Direct Known Subclasses:

IlvWeekendGrid

public class IlvVerticalGanttGrid
extends IlvAbstractGanttGrid

An IlvVerticalGanttGrid draws the vertical grid for a Gantt sheet. The grid can be dynamically adjusted to the grid step according to the zoom scale.

See Also:

IlvGanttSheet.setVerticalGrid(ilog.views.gantt.graphic.grid.IlvGanttGridRenderer)

Field Summary

Fields inherited from class ilog.views.gantt.graphic.grid.IlvAbstractGanttGrid

line

Constructor Summary

Constructors

Constructor and Description
IlvVerticalGanttGrid() Creates an IlvVerticalGanttGrid.

Method Summary

Modifier and Type	Method and Description
Calendar	createCalendar(com.ibm.icu.util.ULocale locale) Creates the Calendar to be used by this grid in the given locale.
void	draw(Graphics dst, IlvGanttGridContext context) Draws the vertical grid in the specified Gantt grid context to the specified Graphics.
Calendar	getCalendar() Deprecated. Starting with JViews 8.8, please use getCalendar(ULocale) instead, passing the locale from the IlvGanttGridContext.
Calendar	getCalendar(Date time) Deprecated. Starting with JViews 8.8, please use getCalendar(ULocale, Date) instead, passing the locale from the IlvGanttGridContext.
Calendar	getCalendar(com.ibm.icu.util.ULocale locale) Returns a copy of the grid's calendar for a given locale.
Calendar	getCalendar(com.ibm.icu.util.ULocale locale, Date time) Returns a copy of the grid's calendar for a given locale that points to the specified time.
protected IlvTimeInterval	getDrawingInterval(Graphics dst, IlvGanttGridContext context) Returns the time interval of the drawing rectangle.
Shape[]	getGridShapes(Graphics dst, boolean selection, IlvGanttGridContext context) Returns the grid shapes used to draw the grid in the specified context as an array of Shape.
void	setCalendar(Calendar calendar) Deprecated. Starting with JViews 8.8, please override the method createCalendar(ULocale) instead of invoking setCalendar.

Methods inherited from class ilog.views.gantt.graphic.grid.IlvAbstractGanttGrid

getForeground, setForeground

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvVerticalGanttGrid

public IlvVerticalGanttGrid()

Creates an IlvVerticalGanttGrid.

Method Detail

draw

public void draw(Graphics dst,
                 IlvGanttGridContext context)

Draws the vertical grid in the specified Gantt grid context to the specified Graphics. It draws a grid and fills in the clip boundaries of the graphics.

Note that this method has been changed since JViews 5.0. The old method was draw(Graphics, IlvGanttSheet). In case you have overridden the old draw method, you have to rewrite your draw method in order to migrate to JViews 5.0. The benefit of using an IlvGanttGridContext instead of an IlvGanttSheet is that a different grid context can be provided while drawing the grid on screen and printing the grid on paper. The grid renderer becomes more flexible and can be used for both displaying on screen and printing on paper.

Parameters:

dst - The Graphics to draw into.

context - The Gantt grid context.

Since:

JViews 5.0

getGridShapes

public Shape[] getGridShapes(Graphics dst,
                             boolean selection,
                             IlvGanttGridContext context)

Returns the grid shapes used to draw the grid in the specified context as an array of Shape. The shapes are in the coordinates of the graphics context that is being drawn. This implementation returns the same lines for drawing or selection.

Parameters:

dst - The Graphics to draw into.

selection - If the shapes returned should be considered for drawing a selection.

context - The Gantt grid context.

Returns:

The array of transformed shapes representing the grid.

Since:

JViews 6.0

getDrawingInterval

protected IlvTimeInterval getDrawingInterval(Graphics dst,
                                             IlvGanttGridContext context)

Returns the time interval of the drawing rectangle.

Parameters:

dst - The graphics context that is being drawn into.

context - The Gantt grid context.

Returns:

The time interval of the drawing rectangle.

Since:

JViews 8.7

setCalendar

@Deprecated
public void setCalendar(Calendar calendar)

Deprecated. Starting with JViews 8.8, please override the method createCalendar(ULocale) instead of invoking setCalendar.

Sets the Calendar of this grid. This calendar is used to calculate the steps of the grid.

Parameters:

calendar - The new calendar.

See Also:

getCalendar(), getCalendar(Date)

getCalendar

@Deprecated
public Calendar getCalendar()

Deprecated. Starting with JViews 8.8, please use getCalendar(ULocale) instead, passing the locale from the IlvGanttGridContext.

Returns a copy of the grid's calendar.

Returns:

The grid's calendar.

See Also:

getCalendar(Date), setCalendar(java.util.Calendar)

getCalendar

@Deprecated
public Calendar getCalendar(Date time)

Deprecated. Starting with JViews 8.8, please use getCalendar(ULocale, Date) instead, passing the locale from the IlvGanttGridContext.

Returns a copy of the grid's calendar that points to the specified time.

Parameters:

time - The current day on the calendar.

Returns:

The grid's calendar, set to the specified time.

Since:

JViews 8.7

See Also:

setCalendar(Calendar), getCalendar()

createCalendar

public Calendar createCalendar(com.ibm.icu.util.ULocale locale)

Creates the Calendar to be used by this grid in the given locale. This calendar is used to calculate the steps of the grid.

Parameters:

locale - The locale of the Gantt sheet.

Returns:

A new calendar.

Since:

JViews 8.8

See Also:

getCalendar(ULocale), getCalendar(ULocale, Date)

getCalendar

public Calendar getCalendar(com.ibm.icu.util.ULocale locale)

Returns a copy of the grid's calendar for a given locale.

Parameters:

locale - The locale of the Gantt sheet.

Returns:

The grid's calendar.

Since:

JViews 8.8

See Also:

getCalendar(ULocale, Date), createCalendar(ULocale)

getCalendar

public Calendar getCalendar(com.ibm.icu.util.ULocale locale,
                            Date time)

Returns a copy of the grid's calendar for a given locale that points to the specified time.

Parameters:

locale - The locale of the Gantt sheet.

time - The current day on the calendar.

Returns:

The grid's calendar, set to the specified time.

Since:

JViews 8.8

See Also:

createCalendar(ULocale), getCalendar(ULocale)