public class IlvTimeStepsDefinition extends IlvStepsDefinition
Modifier and Type | Field and Description |
---|---|
protected IlvTimeUnit[] |
autoUnits
The array of units used for the automatic calculation of the step unit.
|
Constructor and Description |
---|
IlvTimeStepsDefinition()
Creates a new time steps definition.
|
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.
|
getLocale, getScale, getULocale, hasNext, nextStep, nextSubStep
protected IlvTimeUnit[] autoUnits
public IlvTimeStepsDefinition()
public void localeChanged()
localeChanged
in class IlvStepsDefinition
public void update()
update
in class IlvStepsDefinition
public IlvTimeUnit[] getAutoUnits()
autoUnits
array.setAutoUnits(ilog.views.chart.IlvTimeUnit[])
public void setAutoUnits(IlvTimeUnit[] units)
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.setAutoUnit(boolean)
,
computeTimeUnit()
public final boolean isAutoUnit()
public void setAutoUnit(boolean auto)
true
, the step unit is
automatically computed according to the visible range shown by the
scale.public final IlvTimeUnit getUnit()
public void setUnit(IlvTimeUnit unit)
isAutoUnit()
,
getUnit()
protected IlvTimeUnit computeTimeUnit()
setAutoUnit(boolean)
public double previousStep(double v)
IlvTimeUnit.previousUnitTime(java.util.Calendar)
method of the
current step unit.previousStep
in class IlvStepsDefinition
public double incrementStep(double v)
IlvTimeUnit.incrementTime(java.util.Calendar)
method of the
current step unit.incrementStep
in class IlvStepsDefinition
public String computeLabel(double value)
IlvTimeUnit.format(java.text.DateFormat, java.util.Calendar)
method of the
current step unit.computeLabel
in class IlvStepsDefinition
value
- Numeric coordinate value.public final boolean isAutoSubStepUnit()
setAutoSubStepUnit(boolean)
,
setSubStepUnit(ilog.views.chart.IlvTimeUnit)
,
setSubStepCount(int)
public void setAutoSubStepUnit(boolean auto)
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
.
isAutoSubStepUnit()
,
setSubStepUnit(ilog.views.chart.IlvTimeUnit)
,
setSubStepCount(int)
public boolean hasSubStep()
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.hasSubStep
in class IlvStepsDefinition
public final IlvTimeUnit getSubStepUnit()
setSubStepUnit(ilog.views.chart.IlvTimeUnit)
,
setSubStepCount(int)
public void setSubStepUnit(IlvTimeUnit subStepUnit)
Note: The bean property subStepUnit
must not be specified
together with the bean properties autoSubStepUnit
or subStepCount
.
isAutoSubStepUnit()
,
getSubStepUnit()
public int getSubStepCount()
setSubStepCount(int)
public void setSubStepCount(int count)
Note: The bean property subStepCount
must not be specified
together with the bean properties autoSubStepUnit
or subStepUnit
.
public double previousSubStep(double v)
previousSubStep
in class IlvStepsDefinition
IlvStepsDefinition.hasSubStep()
public double incrementSubStep(double v)
incrementSubStep
in class IlvStepsDefinition
IlvStepsDefinition.hasSubStep()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.