ilog.views.gantt.scale

Class IlvYearTimeScaleRow

java.lang.Object

ilog.views.gantt.scale.IlvTimeScaleRow

ilog.views.gantt.scale.IlvBasicTimeScaleRow

ilog.views.gantt.scale.IlvYearTimeScaleRow

All Implemented Interfaces:

Serializable, SwingConstants

public class IlvYearTimeScaleRow
extends IlvBasicTimeScaleRow

This class implements methods from the class IlvBasicTimeScaleRow to provide a complete scale displaying yearly intervals. By default, each yearly interval is displayed with a text formatted using java.text.SimpleDateFormat created with the "yyy" string. The exact result depends on the system Locale, in English "1998" for January 18th, 1998.

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.gantt.scale.IlvBasicTimeScaleRow

LEADING_TICK

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
IlvYearTimeScaleRow() This constructor creates and initializes an IlvYearTimeScaleRow object.

Method Summary

Modifier and Type	Method and Description
protected String	computeDateText(Date time) Computes and returns the text that should be drawn for the interval beginning at the specified time.
protected IlvTimeIncrementPolicy	createTimeIncrementPolicy() Creates the time increment policy for the row.
int	getYearStep() Returns the number of years in an interval.
void	setYearStep(int step) Sets the number of years for an interval.

Methods inherited from class ilog.views.gantt.scale.IlvBasicTimeScaleRow

getAdditionalString, getDateFormat, getFormatString, getHeight, getIntervalMinWidth, getPreferredHeight, getTextColor, getTextFont, getTextPosition, getTickColor, getTimeIncrementPolicy, incrementTime, invalidateDateTextCache, isOverlappingLabelAllowed, nextUnitTime, paint, paintRow, paintText, paintText, paintTick, paintTick, previousUnitTime, setAdditionalString, setFormatString, setHeight, setIntervalMinWidth, setOverlappingLabelAllowed, setTextColor, setTextFont, setTextPosition, setTickColor

Methods inherited from class ilog.views.gantt.scale.IlvTimeScaleRow

getComponentOrientation, getLocale, getTimeScale, getULocale, isVisible, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvYearTimeScaleRow

public IlvYearTimeScaleRow()

This constructor creates and initializes an IlvYearTimeScaleRow object.

Method Detail

getYearStep

public int getYearStep()

Returns the number of years in an interval. The default is 1.

Returns:

The number of years for a scale interval.

Since:

JViews 6.0

setYearStep

public void setYearStep(int step)

Sets the number of years for an interval. It should be a positive number greater than 1.

Parameters:

step - The number of years for a scale interval.

Since:

JViews 6.0

See Also:

getYearStep()

createTimeIncrementPolicy

protected IlvTimeIncrementPolicy createTimeIncrementPolicy()

Creates the time increment policy for the row. The policy will determine the time increments used by the row for tick marks and labeling.

Specified by:

createTimeIncrementPolicy in class IlvBasicTimeScaleRow

Returns:

The time increment policy.

Since:

JViews 7.5

See Also:

IlvBasicTimeScaleRow.getTimeIncrementPolicy()

computeDateText

protected String computeDateText(Date time)

Computes and returns the text that should be drawn for the interval beginning at the specified time. The year's current DateFormat is used to format the time. IlvBasicTimeScaleRow.invalidateDateTextCache() must be invoked whenever a year property changes which affects how this method formats the text.

Overrides:

computeDateText in class IlvBasicTimeScaleRow

Parameters:

time - The start time of the scale interval.

Returns:

The formatted text for the specified interval.

Since:

JViews 6.0

See Also:

IlvBasicTimeScaleRow.getDateFormat()