ilog.views.gantt.scale

Class IlvQuarterTimeScaleRow

java.lang.Object

ilog.views.gantt.scale.IlvTimeScaleRow

ilog.views.gantt.scale.IlvBasicTimeScaleRow

ilog.views.gantt.scale.IlvQuarterTimeScaleRow

All Implemented Interfaces:

Serializable, SwingConstants

public class IlvQuarterTimeScaleRow
extends IlvBasicTimeScaleRow

This class implements methods from the parent class IlvBasicTimeScaleRow to provide a complete scale displaying quarter intervals. By default, each quarter interval is displayed with a text partly formatted using a java.text.SimpleDateFormat created with the "yyyy" string. The exact result depends on the year mode and on the string chosen to display the "Quarter" text. For example, by default, if year mode is set, the result will be "Qtr. 1 1998" for January 1998.

The Quarter timescale row supports alternate locales by utilizing resource files. The resource files are documented here.

See Also:

setYearMode(boolean), setQuarterShortString(java.lang.String), setQuarterLongString(java.lang.String), 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
IlvQuarterTimeScaleRow() This constructor creates and initializes an IlvQuarterTimeScaleRow 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.
String	getQuarterLongString() Returns the string that will be used in non-year mode.
String	getQuarterShortString() Returns the string that will be used in year mode.
boolean	isYearMode() Returns whether the displayed label contains the year or not.
void	setQuarterLongString(String str) Sets the string that will be used in non-year mode.
void	setQuarterShortString(String str) This method sets the string that will be used in year mode.
void	setYearMode(boolean val) Toggles the year mode to display labels.

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

IlvQuarterTimeScaleRow

public IlvQuarterTimeScaleRow()

This constructor creates and initializes an IlvQuarterTimeScaleRow object.

Method Detail

setYearMode

public void setYearMode(boolean val)

Toggles the year mode to display labels.

If the val argument is true, the label is displayed as follows: Qtr. 1 1998

Otherwise, it will be displayed like this : Quarter 1

By default, val is true.

Parameters:

val - the value of the year mode.

See Also:

setQuarterShortString(java.lang.String), setQuarterLongString(java.lang.String)

isYearMode

public boolean isYearMode()

Returns whether the displayed label contains the year or not.

Returns:

Indicates whether the displayed label contains the year.

See Also:

setYearMode(boolean)

setQuarterShortString

public void setQuarterShortString(String str)

This method sets the string that will be used in year mode. The default is "Qtr. ".

Parameters:

str - The string to be set.

See Also:

setYearMode(boolean)

getQuarterShortString

public String getQuarterShortString()

Returns the string that will be used in year mode.

Returns:

The string used in year mode.

See Also:

setQuarterShortString(java.lang.String)

setQuarterLongString

public void setQuarterLongString(String str)

Sets the string that will be used in non-year mode. The default is "Quarter ".

Parameters:

str - The string to be set.

See Also:

setYearMode(boolean)

getQuarterLongString

public String getQuarterLongString()

Returns the string that will be used in non-year mode.

Returns:

The string used in non-year mode.

See Also:

setQuarterLongString(java.lang.String)

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. This method returns an instance of IlvTimeIncrementPolicy.Month that has a monthStep value of 3.

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 row's current DateFormat is used to format the time. IlvBasicTimeScaleRow.invalidateDateTextCache() must be invoked whenever a row 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.

See Also:

IlvBasicTimeScaleRow.getDateFormat()