ilog.views.gantt.scale

Class IlvTimeWidthVisibilityPredicate

java.lang.Object

ilog.views.gantt.scale.IlvTimeWidthVisibilityPredicate

All Implemented Interfaces:

IlvVisibilityPredicate

public class IlvTimeWidthVisibilityPredicate
extends Object
implements IlvVisibilityPredicate

The IlvTimeWidthVisibilityPredicate class provides a way to specify a condition based on the size of a unit of time.

Since:

JViews 6.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHARACTER The unit type to interpret the value that can be compared with a number of characters.
static int	PIXEL The unit type to interpret the value that can be compared with a pixel.

Constructor Summary

Constructors

Constructor and Description
IlvTimeWidthVisibilityPredicate() Creates a new IlvTimeWidthVisibilityPredicate.
IlvTimeWidthVisibilityPredicate(int timeUnit, int type, double value) Creates a new IlvTimeWidthVisibilityPredicate.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(Graphics dst, IlvTimeScale.PaintContext context) Gets the status of this condition.
Font	getFont() Gets the font used for a comparison based on characters.
int	getTimeUnit() Gets the time unit used for the condition.
int	getType() Gets the unit type to interpret the value.
double	getValue() Gets the value used for the comparison.
void	setFont(Font font) Sets the font used for a comparison based on characters.
void	setTimeUnit(int timeUnit) Sets the Calendar time unit to use for the condition.
void	setType(int type) Sets the unit type used to interpret the value.
void	setValue(double value) Sets the value used for the comparison.

Methods inherited from class java.lang.Object

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

Field Detail

PIXEL

public static int PIXEL

The unit type to interpret the value that can be compared with a pixel.

CHARACTER

public static int CHARACTER

The unit type to interpret the value that can be compared with a number of characters. The size of the character used for the comparison is the widest character, so if you are using a variable width font, you should take this into account.

Constructor Detail

IlvTimeWidthVisibilityPredicate

public IlvTimeWidthVisibilityPredicate()

Creates a new IlvTimeWidthVisibilityPredicate.

IlvTimeWidthVisibilityPredicate

public IlvTimeWidthVisibilityPredicate(int timeUnit,
                                       int type,
                                       double value)

Creates a new IlvTimeWidthVisibilityPredicate.

Parameters:

timeUnit - The time unit to use for the condition.

type - The unit type to interpret the value.

value - The value to compare against.

Method Detail

getTimeUnit

public int getTimeUnit()

Gets the time unit used for the condition. This is a Calendar time unit.

Returns:

The Calendartime unit.

setTimeUnit

public void setTimeUnit(int timeUnit)

Sets the Calendar time unit to use for the condition.

Parameters:

timeUnit - The Calendar time unit.

getType

public int getType()

Gets the unit type to interpret the value. It is either PIXEL or CHARACTER.

Returns:

The unit type.

See Also:

PIXEL, CHARACTER

setType

public void setType(int type)

Sets the unit type used to interpret the value. It is either PIXEL or CHARACTER.

Parameters:

type - The unit type.

See Also:

PIXEL, CHARACTER

getValue

public double getValue()

Gets the value used for the comparison.

Returns:

The value used for the comparison.

setValue

public void setValue(double value)

Sets the value used for the comparison.

Parameters:

value - The value for which the interpretation depends upon the type.

getFont

public Font getFont()

Gets the font used for a comparison based on characters.

Returns:

The font.

setFont

public void setFont(Font font)

Sets the font used for a comparison based on characters. If none is set, the font set on the time scale is used.

Parameters:

font - The font.

evaluate

public boolean evaluate(Graphics dst,
                        IlvTimeScale.PaintContext context)

Gets the status of this condition.

Specified by:

evaluate in interface IlvVisibilityPredicate

Parameters:

dst - The destination graphics.

context - The IlvTimeScale.PaintContextcontext in which the time scale paints.

Returns:

true if the condition is satisfied, false otherwise.