ilog.views.chart

Class IlvTimeStepsDefinition

java.lang.Object

ilog.views.chart.IlvStepsDefinition

ilog.views.chart.IlvTimeStepsDefinition

All Implemented Interfaces:

Serializable

public class IlvTimeStepsDefinition
extends IlvStepsDefinition

Implements a default numbering of time steps.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IlvTimeUnit[]	autoUnits The array of units used for the automatic calculation of the step unit.

Constructor Summary

Constructors

Constructor and Description
IlvTimeStepsDefinition() Creates a new time steps definition.

Method Summary

Modifier and Type	Method and Description
String	computeLabel(double value) Computes the label associated with the specified value.
protected IlvTimeUnit	computeTimeUnit() Invoked to compute the time unit when the automatic mode is enabled.
IlvTimeUnit[]	getAutoUnits() Returns the available units for the automatic calculation of the step unit.
int	getSubStepCount() Returns the number of substeps.
IlvTimeUnit	getSubStepUnit() Returns the minor ticks unit.
IlvTimeUnit	getUnit() Returns the step unit.
boolean	hasSubStep() Indicates whether this object defines substeps for minor ticks.
double	incrementStep(double v) Returns the next step value.
double	incrementSubStep(double v) Returns the next substep value.
boolean	isAutoSubStepUnit() Indicates whether the minor ticks unit is automatically computed.
boolean	isAutoUnit() Indicates whether the step unit is automatically computed.
void	localeChanged() This method is invoked when the current locale has changed.
double	previousStep(double v) Returns the step value immediately before the specified value.
double	previousSubStep(double v) Returns the substep value immediately before the specified value.
void	setAutoSubStepUnit(boolean auto) Toggles the automatic calculation of the minor ticks unit.
void	setAutoUnit(boolean auto) Toggles the automatic calculation of the step unit.
void	setAutoUnits(IlvTimeUnit[] units) Specifies the available units for the automatic calculation of the step unit.
void	setSubStepCount(int count) Sets the number of substeps.
void	setSubStepUnit(IlvTimeUnit subStepUnit) Specifies the minor ticks unit.
void	setUnit(IlvTimeUnit unit) Sets the step unit.
void	update() Called by the scale before it computes the step values.

Methods inherited from class ilog.views.chart.IlvStepsDefinition

getLocale, getScale, getULocale, hasNext, nextStep, nextSubStep

Methods inherited from class java.lang.Object

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

Field Detail

autoUnits

protected IlvTimeUnit[] autoUnits

The array of units used for the automatic calculation of the step unit.

See Also:

setAutoUnit(boolean), setAutoUnits(ilog.views.chart.IlvTimeUnit[])

Constructor Detail

IlvTimeStepsDefinition

public IlvTimeStepsDefinition()

Creates a new time steps definition.

Method Detail

localeChanged

public void localeChanged()

This method is invoked when the current locale has changed. Subclasses can override this method in order to clear locale-dependent caches.

Overrides:

localeChanged in class IlvStepsDefinition

update

public void update()

Called by the scale before it computes the step values. This implementation updates the step unit and the substep unit if either automatic mode is on.

Overrides:

update in class IlvStepsDefinition

getAutoUnits

public IlvTimeUnit[] getAutoUnits()

Returns the available units for the automatic calculation of the step unit.

Returns:

A copy of the autoUnits array.

See Also:

setAutoUnits(ilog.views.chart.IlvTimeUnit[])

setAutoUnits

public void setAutoUnits(IlvTimeUnit[] units)

Specifies the available units for the automatic calculation of the step unit.

Parameters:

units - An array of units that will be considered during the automatic calculation. If this parameter is null, the definition object will chose among a predefined set of units.

See Also:

setAutoUnit(boolean), computeTimeUnit()

isAutoUnit

public final boolean isAutoUnit()

Indicates whether the step unit is automatically computed.

See Also:

setAutoUnit(boolean), setUnit(ilog.views.chart.IlvTimeUnit)

setAutoUnit

public void setAutoUnit(boolean auto)

Toggles the automatic calculation of the step unit. When this property is set to true, the step unit is automatically computed according to the visible range shown by the scale.

See Also:

isAutoUnit(), setUnit(ilog.views.chart.IlvTimeUnit), computeTimeUnit()

getUnit

public final IlvTimeUnit getUnit()

Returns the step unit.

setUnit

public void setUnit(IlvTimeUnit unit)

Sets the step unit. Calling this method toggles off the automatic calculation of the step unit.

See Also:

isAutoUnit(), getUnit()

computeTimeUnit

protected IlvTimeUnit computeTimeUnit()

Invoked to compute the time unit when the automatic mode is enabled.

See Also:

setAutoUnit(boolean)

previousStep

public double previousStep(double v)

Returns the step value immediately before the specified value. This method calls the IlvTimeUnit.previousUnitTime(java.util.Calendar) method of the current step unit.

Specified by:

previousStep in class IlvStepsDefinition

incrementStep

public double incrementStep(double v)

Returns the next step value. This method calls the IlvTimeUnit.incrementTime(java.util.Calendar) method of the current step unit.

Specified by:

incrementStep in class IlvStepsDefinition

computeLabel

public String computeLabel(double value)

Computes the label associated with the specified value. This method calls the IlvTimeUnit.format(java.text.DateFormat, java.util.Calendar) method of the current step unit.

Specified by:

computeLabel in class IlvStepsDefinition

Parameters:

value - Numeric coordinate value.

Returns:

A label denoting this value.

isAutoSubStepUnit

public final boolean isAutoSubStepUnit()

Indicates whether the minor ticks unit is automatically computed.

Since:

JViews 8.0

See Also:

setAutoSubStepUnit(boolean), setSubStepUnit(ilog.views.chart.IlvTimeUnit), setSubStepCount(int)

setAutoSubStepUnit

public void setAutoSubStepUnit(boolean auto)

Toggles the automatic calculation of the minor ticks unit. When this property is set to true, the minor ticks unit is automatically computed according to the major ticks unit.

Note: The bean property autoSubStepUnit must not be specified together with the bean properties subStepUnit or subStepCount.

Since:

JViews 8.0

See Also:

isAutoSubStepUnit(), setSubStepUnit(ilog.views.chart.IlvTimeUnit), setSubStepCount(int)

hasSubStep

public boolean hasSubStep()

Indicates whether this object defines substeps for minor ticks. This returns true if either a substep unit has been set, or a substep count has been set, or the substep unit has been marked for automatic computation.

Overrides:

hasSubStep in class IlvStepsDefinition

Since:

JViews 8.0

getSubStepUnit

public final IlvTimeUnit getSubStepUnit()

Returns the minor ticks unit.

Since:

JViews 8.0

See Also:

setSubStepUnit(ilog.views.chart.IlvTimeUnit), setSubStepCount(int)

setSubStepUnit

public void setSubStepUnit(IlvTimeUnit subStepUnit)

Specifies the minor ticks unit. The specified value must be less than the step unit. This method toggles off the automatic calculation of the substep unit.

Note: The bean property subStepUnit must not be specified together with the bean properties autoSubStepUnit or subStepCount.

Since:

JViews 8.0

See Also:

isAutoSubStepUnit(), getSubStepUnit()

getSubStepCount

public int getSubStepCount()

Returns the number of substeps. This is the number of minor ticks between two adjacent major ticks.

Since:

JViews 8.0

See Also:

setSubStepCount(int)

setSubStepCount

public void setSubStepCount(int count)

Sets the number of substeps. This method fixes the substep unit to match the specified number of substeps: the substep unit will be equal to the step unit divided by the number of substeps plus one.

Note: The bean property subStepCount must not be specified together with the bean properties autoSubStepUnit or subStepUnit.

Since:

JViews 8.0

previousSubStep

public double previousSubStep(double v)

Returns the substep value immediately before the specified value.

Overrides:

previousSubStep in class IlvStepsDefinition

Since:

JViews 8.0

See Also:

IlvStepsDefinition.hasSubStep()

incrementSubStep

public double incrementSubStep(double v)

Returns the next substep value.

Overrides:

incrementSubStep in class IlvStepsDefinition

Since:

JViews 8.0

See Also:

IlvStepsDefinition.hasSubStep()