ilog.views.gantt.scale

Class IlvTimeScale.PaintContext

java.lang.Object

ilog.views.gantt.scale.IlvTimeScale.PaintContext

Enclosing class:

IlvTimeScale

public static class IlvTimeScale.PaintContext
extends Object

A PaintContext defines the context in which the time scale paints. It defines the following parameters required for painting the time scale:

• The visible time interval that defines the portion of the time scale to be painted. Use the methods: getVisibleTime, setVisibleTime, getVisibleDuration, and setVisibleDuration to get or to set the visible time interval.
• The horizontal translation and the horizontal zoom factor applied while painting the time scale. Use the methods: getXTranslation and getXZoomFactor to return the horizontal translation and the horizontal zoom factor. Note, that the values returned by these methods are only useful when the time scale is configured with a linear time converter. Use the getLocation(java.util.Date) and getTime(long) methods to more generally convert between positions along the horizontal axis and time.

The PaintContext is generally used by the method paint(Graphics, Rectangle, PaintContext). The time scale has a cached PaintContext that can be retrieved by calling getPaintContext. It is the paint context used to paint the time scale when you call the paintComponent method.

Since:

JViews 5.0

See Also:

IlvTimeScale.getPaintContext(), IlvTimeScale.paint(java.awt.Graphics, java.awt.Rectangle, ilog.views.gantt.scale.IlvTimeScale.PaintContext)

Constructor Summary

Constructors

Constructor and Description
PaintContext(IlvTimeScale.PaintContext context) Creates a new PaintContext by copying parameters from an existing PaintContext.
PaintContext(IlvTimeScale timeScale, Date startTime, IlvDuration duration, int viewStart, int viewWidth) Creates a PaintContext object that will paint a time interval of the time scale within a viewport.
PaintContext(IlvTimeScale timeScale, Date startTime, IlvDuration duration, int viewStart, int viewWidth, Font font) Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context. Instead, use the IlvTimeScale.PaintContext(IlvTimeScale, Date, IlvDuration, int, int) constructor.

Method Summary

Modifier and Type	Method and Description
Date	computeVisibleTimeScroll(long x0, long x1) Computes the beginning of the visible interval that will cause the time that currently corresponds with the position x0 to correspond to the position x1.
int	getDaySize() Returns the number of pixels a day takes in this paint context.
Font	getFont() Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context.
int	getHourSize() Returns the number of pixels an hour takes in this paint context.
long	getLocation(Date time) Returns the x position in screen coordinates that corresponds to the specified time.
int	getMinuteSize() Returns the number of pixels a minute takes in this paint context.
int	getMonthSize() Returns the number of pixels a month takes in this paint context.
int	getQuarterSize() Returns the number of pixels a quarter takes in this paint context.
int	getSizeOf(int unit) Returns the number of pixels a unit of time takes in this paint context.
Date	getTime(long x) Returns the time that corresponds to the specified x position in screen coordinates.
IlvTimeScale	getTimeScale() Returns the time scale from the paint context
IlvDuration	getVisibleDuration() Returns the duration of the time interval painted by the scale.
Date	getVisibleTime() Returns the beginning of the time interval displayed by the scale.
int	getWeekSize() Returns the number of pixels a week takes in this paint context.
double	getXTranslation() Returns the horizontal translation used while painting the time scale.
double	getXZoomFactor() Returns the horizontal zoom factor used while painting the time scale.
int	getYearSize() Returns the number of pixels a year takes in this paint context.
void	setFont(Font font) Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context.
void	setVisibleDuration(IlvDuration duration) Sets the duration of the time interval painted by the scale.
void	setVisibleTime(Date time) Sets the beginning of the time interval painted by the scale.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaintContext

@Deprecated
public PaintContext(IlvTimeScale timeScale,
                                Date startTime,
                                IlvDuration duration,
                                int viewStart,
                                int viewWidth,
                                Font font)

Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context. Instead, use the IlvTimeScale.PaintContext(IlvTimeScale, Date, IlvDuration, int, int) constructor.

Creates a PaintContext that will paint a time interval of the time scale within a viewport.

Parameters:

timeScale - The time scale.

startTime - The beginning of the time interval to be painted.

duration - The duration of the time interval to be painted.

viewStart - The beginning of the viewport.

viewWidth - The width of the viewport.

font - The font used to paint the labels of the time scale.

Since:

JViews 6.0

PaintContext

public PaintContext(IlvTimeScale timeScale,
                    Date startTime,
                    IlvDuration duration,
                    int viewStart,
                    int viewWidth)

Creates a PaintContext object that will paint a time interval of the time scale within a viewport.

Parameters:

timeScale - The time scale.

startTime - The beginning of the time interval to be painted.

duration - The duration of the time interval to be painted.

viewStart - The beginning of the viewport.

viewWidth - The width of the viewport.

Since:

JViews 8.5

PaintContext

public PaintContext(IlvTimeScale.PaintContext context)

Creates a new PaintContext by copying parameters from an existing PaintContext.

Parameters:

context - The existing paint context to copy from.

Method Detail

getXTranslation

public double getXTranslation()

Returns the horizontal translation used while painting the time scale.

Returns:

The horizontal translation.

getXZoomFactor

public double getXZoomFactor()

Returns the horizontal zoom factor used while painting the time scale.

Returns:

The horizontal zoom factor.

getVisibleTime

public Date getVisibleTime()

Returns the beginning of the time interval displayed by the scale.

See Also:

setVisibleTime(java.util.Date)

setVisibleTime

public void setVisibleTime(Date time)

Sets the beginning of the time interval painted by the scale. This function adjusts the horizontal translation so that the specified date appears at the beginning of the painted time scale.

Parameters:

time - The new time value.

See Also:

getVisibleTime()

getVisibleDuration

public IlvDuration getVisibleDuration()

Returns the duration of the time interval painted by the scale.

See Also:

setVisibleDuration(ilog.views.gantt.IlvDuration)

setVisibleDuration

public void setVisibleDuration(IlvDuration duration)

Sets the duration of the time interval painted by the scale.

Parameters:

duration - The new duration value.

See Also:

getVisibleDuration()

getFont

@Deprecated
public Font getFont()

Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context.

Gets the font used to paint the labels of the time scale.

Returns:

The font.

See Also:

setFont(java.awt.Font)

setFont

@Deprecated
public void setFont(Font font)

Deprecated. Beginning with Perforce JViews 8.5, it is no longer recommended to override the time scale's font by setting a font on the paint context.

Sets the font used to paint the labels of the time scale. This parameter can be null. In this case the font parameter in the context is ignored. The fonts defined for the time scale rows are used instead.

Parameters:

font - The font.

getLocation

public long getLocation(Date time)

Returns the x position in screen coordinates that corresponds to the specified time.

Parameters:

time - The time.

Returns:

The x position in screen coordinates.

Since:

JViews 6.0

getTime

public Date getTime(long x)

Returns the time that corresponds to the specified x position in screen coordinates.

Parameters:

x - The x position in screen coordinates.

Returns:

The time.

Since:

JViews 6.0

computeVisibleTimeScroll

public Date computeVisibleTimeScroll(long x0,
                                     long x1)

Computes the beginning of the visible interval that will cause the time that currently corresponds with the position x0 to correspond to the position x1.

Parameters:

x0 - The reference screen coordinate position.

x1 - The new screen coordinate position.

Returns:

The visible time that will cause the time that corresponds with x0 to shift and correspond with x1.

Since:

JViews 6.5

getSizeOf

public int getSizeOf(int unit)

Returns the number of pixels a unit of time takes in this paint context.

Note, that this method returns the number of pixels for an idealized unit of time. This may be adequate for most uses, but it is not perfectly accurate when handling leap years, months of different lengths, daylight saving time, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Parameters:

unit - A Calendar field.

Returns:

The number of pixels needed in this paint context to represent one unit of this Calendar field.

Since:

JViews 6.0

getYearSize

public int getYearSize()

Returns the number of pixels a year takes in this paint context.

Note, that this method returns the number of pixels for an idealized year. This may be adequate for most uses, but it is not perfectly accurate when handling leap years or nonlinear time scales. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one year.

Since:

JViews 6.0

getQuarterSize

public int getQuarterSize()

Returns the number of pixels a quarter takes in this paint context.

Note, that this method returns the number of pixels for an idealized quarter. This may be adequate for most uses, but it is not perfectly accurate when handling leap years, months of different lengths, daylight saving time, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one quarter.

Since:

JViews 6.0

getMonthSize

public int getMonthSize()

Returns the number of pixels a month takes in this paint context.

Note, that this method returns the number of pixels for an idealized month. This may be adequate for most uses, but it is not perfectly accurate when handling months of different lengths, daylight saving time, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one month.

Since:

JViews 6.0

getWeekSize

public int getWeekSize()

Returns the number of pixels a week takes in this paint context.

Note, that this method returns the number of pixels for an idealized week. This may be adequate for most uses, but it is not perfectly accurate when handling daylight saving time, leap seconds, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one week.

Since:

JViews 6.0

getDaySize

public int getDaySize()

Returns the number of pixels a day takes in this paint context.

Note, that this method returns the number of pixels for an idealized day. This may be adequate for most uses, but it is not perfectly accurate when handling daylight saving time, leap seconds, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one day.

Since:

JViews 6.0

getHourSize

public int getHourSize()

Returns the number of pixels an hour takes in this paint context.

Note, that this method returns the number of pixels for an idealized hour. This may be adequate for most uses, but it is not perfectly accurate when handling leap seconds, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one hour.

Since:

JViews 6.0

getMinuteSize

public int getMinuteSize()

Returns the number of pixels a minute takes in this paint context.

Note, that this method returns the number of pixels for an idealized minute. This may be adequate for most uses, but it is not perfectly accurate when handling leap seconds, nonlinear time scales, and so on. For absolute accuracy, use the difference between getLocation(Date) for a specific start and end date.

Returns:

The number of pixels needed in this paint context to represent one minute.

Since:

JViews 6.0

getTimeScale

public IlvTimeScale getTimeScale()

Returns the time scale from the paint context

Returns:

The time scale this paint context is in.

Since:

JViews 6.0