ilog.views.gantt.scale

Class IlvTimeScaleRow

java.lang.Object

ilog.views.gantt.scale.IlvTimeScaleRow

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvBasicTimeScaleRow

public abstract class IlvTimeScaleRow
extends Object
implements Serializable

This abstract class is the minimum implementation that a row, to be put in a IlvTimeScale, should extend. An IlvTimeScaleRow will display a part of the IlvTimeScale corresponding to a particular time unit.

An IlvTimeScaleRow can belong to at most one IlvTimeScale at any given time.

See Also:

IlvTimeScale, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvTimeScaleRow() This constructor creates a new instance of a time scale row.

Method Summary

Modifier and Type	Method and Description
ComponentOrientation	getComponentOrientation() Returns the language-sensitive orientation of this scale row.
Locale	getLocale() Returns the locale of this scale row.
abstract int	getPreferredHeight() This method returns the preferred height of this row.
protected IlvTimeScale	getTimeScale() This method can be used in subclasses to access the referring IlvTimeScale.
ULocale	getULocale() Returns the locale of this scale row.
boolean	isVisible() This method indicates whether the row is visible.
abstract Date	nextUnitTime(Date time) This method is called to compute the next unit value after the specified time.
protected abstract void	paint(Graphics dst, Rectangle rect, IlvTimeScale.PaintContext context) This method should be overridden to draw the scale row in the specified paint context.
protected abstract void	paintRow(Graphics dst, Rectangle rect) Deprecated. Beginning with Rogue Wave JViews 8.5 use paint(Graphics, Rectangle, IlvTimeScale.PaintContext) instead.
abstract Date	previousUnitTime(Date time) This method is called to compute the previous unit value before the specified time.
void	setVisible(boolean visible) This method can be used to switch the visibility setting of this row.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTimeScaleRow

public IlvTimeScaleRow()

This constructor creates a new instance of a time scale row. This IlvTimeScaleRow instance can be added to an IlvTimeScale object using the addRow method. Then, it can be removed using the removeRow method.

See Also:

IlvTimeScale.addRow(ilog.views.gantt.scale.IlvTimeScaleRow), IlvTimeScale.setRow(int, ilog.views.gantt.scale.IlvTimeScaleRow), IlvTimeScale.removeRow(ilog.views.gantt.scale.IlvTimeScaleRow)

Method Detail

setVisible

public void setVisible(boolean visible)

This method can be used to switch the visibility setting of this row. Started with the JViews 6.0 release, it can affect the height of the IlvTimeScale object it belongs too.

Parameters:

visible - The state of the row.

isVisible

public boolean isVisible()

This method indicates whether the row is visible.

getPreferredHeight

public abstract int getPreferredHeight()

This method returns the preferred height of this row.

getTimeScale

protected IlvTimeScale getTimeScale()

This method can be used in subclasses to access the referring IlvTimeScale.

nextUnitTime

public abstract Date nextUnitTime(Date time)

This method is called to compute the next unit value after the specified time. If time is already an integer unit value, the method returns a copy of it. Its implementation depends on the unit of the scale row. For example, in a minute-unit time scale row, the next unit time of January 14th, 2001, 8:12:34 is January 14th, 2001, 8:13:00, and the next unit time of January 14th, 2001, 9:01:00 is January 14th, 2001, 9:01:00. This method is necessary for integer-zoom interaction on the scale and useful when drawing it. To implement this method, you can use a Calendar object provided by a method from the class IlvTimeScale.

Parameters:

time - The time to compute the ceiling.

See Also:

IlvTimeScale.getCalendar()

previousUnitTime

public abstract Date previousUnitTime(Date time)

This method is called to compute the previous unit value before the specified time. If time is already an integer unit value, the method returns a copy of it. For example, in a minute-unit time scale row, the previous unit time of January 14th, 2001, 8:12:34 is January 14th, 2001, 8:12:00, and the previous unit time of January 14th, 2001, 9:01:00 is January 14th, 2001, 9:01:00. Its implementation depends on the unit of the scale row. This method is necessary for integer-zoom interaction on the scale. To implement this method, you can use a Calendar object provided by a method from the class IlvTimeScale.

Parameters:

time - The time to floor.

See Also:

IlvTimeScale.getCalendar()

paintRow

@Deprecated
protected abstract void paintRow(Graphics dst,
                                             Rectangle rect)

Deprecated. Beginning with Rogue Wave JViews 8.5 use paint(Graphics, Rectangle, IlvTimeScale.PaintContext) instead.

This method should be overridden to draw the scale row.

Parameters:

dst - The destination Graphics.

rect - The rectangle in which the scale row should be drawn.

paint

protected abstract void paint(Graphics dst,
                              Rectangle rect,
                              IlvTimeScale.PaintContext context)

This method should be overridden to draw the scale row in the specified paint context.

Parameters:

dst - The destination Graphics.

rect - The rectangle in which the scale row should be drawn.

context - The paint context.

Since:

JViews 5.0

getLocale

public Locale getLocale()

Returns the locale of this scale row.

Returns:

This scales row's locale.

Since:

JViews 8.7

getULocale

public ULocale getULocale()

Returns the locale of this scale row.

Returns:

This scales row's locale.

Since:

JViews 8.8

getComponentOrientation

public ComponentOrientation getComponentOrientation()

Returns the language-sensitive orientation of this scale row.

Returns:

This scale row's orientation.

Since:

JViews 8.7