ilog.views.gantt.scale

Class IlvBasicTimeScaleRow

java.lang.Object

ilog.views.gantt.scale.IlvTimeScaleRow

ilog.views.gantt.scale.IlvBasicTimeScaleRow

All Implemented Interfaces:

Serializable, SwingConstants

Direct Known Subclasses:

IlvDayTimeScaleRow, IlvHalfDayTimeScaleRow, IlvHourTimeScaleRow, IlvMinuteTimeScaleRow, IlvMonthTimeScaleRow, IlvQuarterTimeScaleRow, IlvWeekTimeScaleRow, IlvYearTimeScaleRow

public abstract class IlvBasicTimeScaleRow
extends IlvTimeScaleRow
implements SwingConstants

This class implements methods of the class IlvTimeScaleRow and provides additional utilities. All painting operations are defined at this level. You should extend this class to determine the time unit management by overriding the createTimeIncrementPolicy() method. The drawing operations are done in the paint(Graphics, Rectangle, IlvTimeScale.PaintContext) method, which displays ticks to separate each unit interval. These ticks are drawn using the paintTick(java.awt.Graphics, java.awt.Point, int, java.awt.FontMetrics, int) method. In the intervals, text representing the time is drawn by the paintText(java.awt.Graphics, java.lang.String, java.awt.Point, java.awt.Point, java.awt.Rectangle, java.awt.FontMetrics, int) method. By default, the text is displayed to the left of the interval.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEADING_TICK The text is centered on the leading tick of the interval.

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
IlvBasicTimeScaleRow() Creates an instance of IlvBasicTimeScale.

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 abstract IlvTimeIncrementPolicy	createTimeIncrementPolicy() Creates the time increment policy for the row.
String	getAdditionalString() This method returns the additional string displayed in the first interval.
Format	getDateFormat() This method returns the appropriate format to display text.
String	getFormatString() This method returns the default string for creating the SimpleDateFormat object.
int	getHeight() Returns the height that was explicitly set for this row.
int	getIntervalMinWidth() This method returns the minimum interval required to draw a text between two ticks.
int	getPreferredHeight() Returns the preferred height of the row.
Color	getTextColor() This method returns the color of the text labels.
Font	getTextFont() This method returns the font of the text labels.
int	getTextPosition() This method returns the position of the text in its interval.
Color	getTickColor() This method returns the color of the ticks.
IlvTimeIncrementPolicy	getTimeIncrementPolicy() Returns the time increment policy for the row.
protected Date	incrementTime(Date time) Returns an incremented value of the scale time unit.
protected void	invalidateDateTextCache() Invalidates the date text cache by clearing it of all entries.
boolean	isOverlappingLabelAllowed() Indicates whether overlapping labels are allowed.
Date	nextUnitTime(Date time) Returns the next unit value after the specified time.
protected void	paint(Graphics dst, Rectangle rect, IlvTimeScale.PaintContext context) This method is overridden to draw the scale row to the specified Graphics and in the specified PaintContext.
protected void	paintRow(Graphics dst, Rectangle rect) Deprecated. Beginning with Perforce JViews 8.5 use paint(Graphics, Rectangle, IlvTimeScale.PaintContext) instead.
protected void	paintText(Graphics dst, Point topLeft, Point bottomRight, String text) Deprecated. Beginning with Perforce JViews 8.5 use and override the paintText(Graphics, String, Point, Point, Rectangle, FontMetrics, int) method instead.
protected void	paintText(Graphics dst, String text, Point topLeft, Point bottomRight, Rectangle rowRect, FontMetrics fm, int textBaseline) This method is called to draw text corresponding to a scale time interval.
protected void	paintTick(Graphics dst, Point pos, int height) Deprecated. Beginning with Perforce JViews 8.5 use and override the paintTick(Graphics, Point, int, FontMetrics, int) method instead.
protected void	paintTick(Graphics dst, Point pos, int height, FontMetrics fm, int textBaseline) This method is called to draw a tick in the scale.
Date	previousUnitTime(Date time) Returns the previous unit value before the specified time.
void	setAdditionalString(String text) This method lets you change the additional string displayed in the first interval.
void	setFormatString(String format) This method allows you to change the default date format string.
void	setHeight(int height) Sets the height of the row.
void	setIntervalMinWidth(int value) This method lets you change the minimum interval required to draw a text between two ticks.
void	setOverlappingLabelAllowed(boolean overlap) Specifies whether overlapping labels are allowed.
void	setTextColor(Color color) This method changes the color of all text labels.
void	setTextFont(Font font) This method changes the font of the current row.
void	setTextPosition(int position) This method changes the position of the text in its interval.
void	setTickColor(Color color) This method changes the color of all ticks.

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

Field Detail

LEADING_TICK

public static final int LEADING_TICK

The text is centered on the leading tick of the interval.

Since:

JViews 8.5

See Also:

setTextPosition(int), Constant Field Values

Constructor Detail

IlvBasicTimeScaleRow

public IlvBasicTimeScaleRow()

Creates an instance of IlvBasicTimeScale.

Method Detail

setTickColor

public void setTickColor(Color color)

This method changes the color of all ticks. If no color has been set, the color of the IlvTimeScale object is used.

Parameters:

color - The new color.

getTickColor

public Color getTickColor()

This method returns the color of the ticks. If no color has been set, it returns the color of the IlvTimeScale object.

Returns:

The tick color.

setTextColor

public void setTextColor(Color color)

This method changes the color of all text labels. If no color has been set, the color of the IlvTimeScale object is used.

Parameters:

color - The new color.

getTextColor

public Color getTextColor()

This method returns the color of the text labels. If no color has been set, it returns the color of the IlvTimeScale object.

Returns:

The text color.

setTextFont

public void setTextFont(Font font)

This method changes the font of the current row. If no font has been set, the font of the IlvTimeScale object is used. Started with the JViews 6.0 release, this method can change the height of the IlvTimeScale object.

Parameters:

font - The new font.

getTextFont

public Font getTextFont()

This method returns the font of the text labels. If no font has been set, the method returns the font of the IlvTimeScale object.

Returns:

The text label font.

setTextPosition

public void setTextPosition(int position)

This method changes the position of the text in its interval.

Parameters:

position - Can take the value SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING, SwingConstants.TRAILING, SwingConstants.CENTER, or LEADING_TICK.

See Also:

getTextPosition()

getTextPosition

public int getTextPosition()

This method returns the position of the text in its interval. The default value is LEADING.

Returns:

The text position, which is one of the values SwingConstants.LEFT, SwingConstants.RIGHT, SwingConstants.LEADING, SwingConstants.TRAILING, SwingConstants.CENTER, or LEADING_TICK.

See Also:

setTextPosition(int)

getAdditionalString

public String getAdditionalString()

This method returns the additional string displayed in the first interval. The string is displayed before the text of the first interval that opens to the left of the row.

Returns:

The text to display.

setAdditionalString

public void setAdditionalString(String text)

This method lets you change the additional string displayed in the first interval. This string is displayed before the text of a time unit interval if that interval extends beyond the visible part of the scale.

Parameters:

text - The additional text.

setIntervalMinWidth

public void setIntervalMinWidth(int value)

This method lets you change the minimum interval required to draw a text between two ticks. If the interval width is less than this value, the text is not drawn. By default, the minimum interval is defined by the width of the first text displayed in the row.

Parameters:

value - The interval to be set, in pixels.

getIntervalMinWidth

public int getIntervalMinWidth()

This method returns the minimum interval required to draw a text between two ticks. If the interval width is less than this value, the text is not drawn. If the value has never been set, the method returns -1 and the width of the first text displayed is used as the minimum width.

Returns:

The minimum interval width.

getHeight

public int getHeight()

Returns the height that was explicitly set for this row. A value of -1 indicates that the row's height will depend upon the text font size. The default value is -1.

Returns:

The height of the row, or -1.

Since:

JViews 6.0

See Also:

setHeight(int), setTextFont(java.awt.Font), getPreferredHeight()

setHeight

public void setHeight(int height)

Sets the height of the row. A value of -1 indicates that the row's height will depend upon the text font size.

Parameters:

height - The height of the row.

Since:

JViews 6.0

See Also:

setTextFont(java.awt.Font), getHeight(), getPreferredHeight()

getPreferredHeight

public int getPreferredHeight()

Returns the preferred height of the row. If the height has been explicitly set, this is the value that will be returned. Otherwise, the preferred height will be derived from the size of the text font.

Specified by:

getPreferredHeight in class IlvTimeScaleRow

Returns:

The preferred height of the row.

See Also:

setHeight(int), setTextFont(java.awt.Font)

isOverlappingLabelAllowed

public boolean isOverlappingLabelAllowed()

Indicates whether overlapping labels are allowed.

Returns:

Whether overlapping labels are allowed.

setOverlappingLabelAllowed

public void setOverlappingLabelAllowed(boolean overlap)

Specifies whether overlapping labels are allowed.

Parameters:

overlap - true if overlapping labels are allowed.

paint

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

This method is overridden to draw the scale row to the specified Graphics and in the specified PaintContext. It calls paintTick(java.awt.Graphics, java.awt.Point, int, java.awt.FontMetrics, int) to perform tick drawings and paintText(java.awt.Graphics, java.lang.String, java.awt.Point, java.awt.Point, java.awt.Rectangle, java.awt.FontMetrics, int) to label the intervals. It also uses nextUnitTime(java.util.Date) to increment the intervals.

This method is called by IlvTimeScale.paint(Graphics, Rectangle, IlvTimeScale.PaintContext) to paint the scale row. In the case that the scale is drawn on the screen, the cached PaintContext of the time scale is used. This method can also be used to print the scale row. In this case, an external PaintContext must be provided in order to print the portion specified by the programmer.

Specified by:

paint in class IlvTimeScaleRow

Parameters:

dst - The destination Graphics.

rect - The rectangle in which the scale row should be drawn. The rectangle should be in the destination (Graphics) coordinates.

context - The paint context in which the scale row paints.

Since:

JViews 5.0

See Also:

IlvTimeScaleRow.getTimeScale(), IlvTimeScale.getTime(long), IlvTimeScale.getLocation(java.util.Date)

paintRow

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

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

This method is overridden to draw the scale row. It calls paint to paint the time scale. The cached PaintContext of the time scale is used.

Specified by:

paintRow in class IlvTimeScaleRow

Parameters:

dst - The destination Graphics.

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

See Also:

IlvTimeScale.getPaintContext()

paintTick

protected void paintTick(Graphics dst,
                         Point pos,
                         int height,
                         FontMetrics fm,
                         int textBaseline)

This method is called to draw a tick in the scale. A tick is the line drawn between two time unit intervals. You can specify a particular color for these ticks by calling setTickColor(Color).

Parameters:

dst - The destination Graphics.

pos - The bottom point of the tick.

height - The maximum height of the tick.

fm - The metrics for the text font that is currently set on dst and is being used to label the scale row.

textBaseline - The baseline Y position at which the text for the time interval is being drawn.

Since:

JViews 8.5

paintTick

@Deprecated
protected void paintTick(Graphics dst,
                                     Point pos,
                                     int height)

Deprecated. Beginning with Perforce JViews 8.5 use and override the paintTick(Graphics, Point, int, FontMetrics, int) method instead.

This method is called to draw a tick in the scale. A tick is the line drawn between two time unit intervals. You can specify a particular color for these ticks.

Parameters:

dst - The destination Graphics.

pos - The bottom point of the tick.

height - The maximum height of the tick.

See Also:

setTickColor(java.awt.Color)

paintText

protected void paintText(Graphics dst,
                         String text,
                         Point topLeft,
                         Point bottomRight,
                         Rectangle rowRect,
                         FontMetrics fm,
                         int textBaseline)

This method is called to draw text corresponding to a scale time interval. The time interval is defined by the rectangle (topLeft, bottomRight). The parameter topLeft.x is the starting location of the time interval or the left edge of the time scale row, whichever is greater. The bottomRight.x parameter is the ending location of the time interval and the starting location of the next time interval. Therefore, when this method is invoked to paint the last interval in the row, bottomRight.x may be greater than the right edge of rowRect.

The text can be centered using the setTextPosition(int) method. The color can be changed using the setTextColor(java.awt.Color) method. The text String representing the time is returned by the computeDateText(java.util.Date) method. This String will be preceded by an additional string set using the setAdditionalString(java.lang.String) method if the interval begins before the visible part of the scale.

Parameters:

dst - The destination Graphics. The text font is already set on the Graphics.

text - The text to paint.

topLeft - The top-left corner of the time scale interval.

bottomRight - The bottom-right corner of the time scale interval.

rowRect - The visible bounds of the time scale row.

fm - The metrics for the text font that is currently set on dst.

textBaseline - The baseline Y position at which the text should be drawn.

Since:

JViews 8.5

paintText

@Deprecated
protected void paintText(Graphics dst,
                                     Point topLeft,
                                     Point bottomRight,
                                     String text)

Deprecated. Beginning with Perforce JViews 8.5 use and override the paintText(Graphics, String, Point, Point, Rectangle, FontMetrics, int) method instead.

This method is called to draw text corresponding to a scale interval. This interval is defined by the rectangle (prevPos, nextPos). The text can be centered using the setTextPosition(int) method. The color can be changed using the setTextColor(java.awt.Color) method. The text String representing the time is returned by the computeDateText(java.util.Date) method and can be preceded by an additional string set using the setAdditionalString(java.lang.String) method if the interval begins before the visible part of the scale.

Parameters:

dst - The destination Graphics.

topLeft - The top-left corner of the rectangle.

bottomRight - The bottom-right corner of the rectangle.

text - The text to paint.

getDateFormat

public Format getDateFormat()

This method returns the appropriate format to display text. By default, the value is a SimpleDateFormat object constructed with the locale / time zone of the scale and a string specified with the setFormatString method (see the java.text.SimpleDate JDK class). Generally, the subclass of IlvBasicTimeScaleRow is responsible for setting this string.

Returns:

The date format.

See Also:

setFormatString(java.lang.String), Component.getLocale()

setFormatString

public void setFormatString(String format)

This method allows you to change the default date format string. This string is used to construct the java.text.SimpleDateFormat object returned by default by the getDateFormat method.

Parameters:

format - A String object that is passed to the constructor of a java.text.SimpleDateFormat object.

See Also:

getDateFormat()

getFormatString

public String getFormatString()

This method returns the default string for creating the SimpleDateFormat object.

Returns:

The default format string.

invalidateDateTextCache

protected void invalidateDateTextCache()

Invalidates the date text cache by clearing it of all entries. This method should be called whenever the row's date format is changed, thereby invalidating all the cached entries. This method must be invoked whenever there is a change in a row property that affects how computeDateText(java.util.Date) formats the text for a given time.

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. Subclasses can override this method as needed. invalidateDateTextCache() must be invoked whenever there is a change in a row property that affects how this method formats the text.

Parameters:

time - The time.

Returns:

The date text.

See Also:

getDateFormat()

createTimeIncrementPolicy

protected abstract 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.

Returns:

The time increment policy.

Since:

JViews 7.5

See Also:

getTimeIncrementPolicy()

getTimeIncrementPolicy

public IlvTimeIncrementPolicy getTimeIncrementPolicy()

Returns the time increment policy for the row. The policy determines the time increments used by the row for tick marks and labeling.

Returns:

The row's time increment policy.

Since:

JViews 7.5

See Also:

createTimeIncrementPolicy()

previousUnitTime

public Date previousUnitTime(Date time)

Returns the previous unit value before the specified time. If time is already an integer unit value, this 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. This method uses the row's time increment policy to compute the previous unit time.

Specified by:

previousUnitTime in class IlvTimeScaleRow

Parameters:

time - The time to floor.

Returns:

The previous unit time value.

Since:

JViews 7.5

See Also:

nextUnitTime(java.util.Date), incrementTime(java.util.Date)

nextUnitTime

public Date nextUnitTime(Date time)

Returns the next unit value after the specified time. If time is already an integer unit value, this method returns a copy of it. 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 uses the row's time increment policy to compute the next unit time.

Specified by:

nextUnitTime in class IlvTimeScaleRow

Parameters:

time - The time to compute the ceiling.

Returns:

The next unit time value.

See Also:

previousUnitTime(java.util.Date), incrementTime(java.util.Date)

incrementTime

protected Date incrementTime(Date time)

Returns an incremented value of the scale time unit. For example, in a time scale row whose time unit has been set to the minute, the increment time of January 14th 2001 8:12:34 is January 14th 2001 8:13:34.

Parameters:

time - The time to increment.

Returns:

The incremented time value.

See Also:

previousUnitTime(java.util.Date), nextUnitTime(java.util.Date)