IlvDefaultStepsDefinition (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvStepsDefinition
- - ilog.views.chart.IlvDefaultStepsDefinition

All Implemented Interfaces:

Serializable
```
public class IlvDefaultStepsDefinition
extends IlvStepsDefinition
```
Implements a default numbering of numeric steps. The IlvDefaultStepsDefinition is the default class used to specify the steps of a scale. It uses the following attributes, which can be explicitly specified or automatically computed:
- A step unit, which corresponds to the value between two consecutive steps.
- A substep unit, which corresponds to the value between two consecutive substeps.
- A number format, which is used to translate step values into labels.
Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int COMPLEX_MODE
Type for complex automatic mode.

static int SIMPLE_MODE
Type for simple automatic mode.

Fields
Modifier and Type	Field and Description
`static int`	`COMPLEX_MODE` Type for complex automatic mode.
`static int`	`SIMPLE_MODE` Type for simple automatic mode.

Constructor Summary

Constructors
Constructor and Description
`IlvDefaultStepsDefinition()` Creates a new `IlvDefaultStepsDefinition` that automatically computes the step and substep units.
`IlvDefaultStepsDefinition(int mode)` Creates a new `IlvDefaultStepsDefinition` that automatically computes the step and substep units with the specified mode.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`adjustRange(IlvDataInterval range)` Adjusts the specified range so that its limits are snapped to unit values.
`String`	`computeLabel(double value)` Computes the label associated to the specified value.
`protected double`	`computeStepUnit()` Invoked to compute the step unit when the automatic mode is enabled.
`int`	`getAutoMode()` Returns the mode for the automatic calculation of the step unit.
`NumberFormat`	`getNumberFormat()` Returns the format used to translate step values into labels.
`double`	`getStepUnit()` Returns the step unit.
`int`	`getSubStepCount()` Returns the number of substeps.
`double`	`getSubStepUnit()` Returns the substep unit.
`boolean`	`hasSubStep()` Indicates whether this object defines substeps.
`double`	`incrementStep(double v)` Returns the next step value.
`double`	`incrementSubStep(double v)` Returns the next substep value.
`boolean`	`isAutoNumberFormat()` Indicates whether the number format is automatically computed.
`boolean`	`isAutoStepUnit()` Indicates whether the step unit is automatically computed.
`boolean`	`isAutoSubStepUnit()` Indicates whether the substep unit is automatically computed.
`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`	`setAutoMode(int mode)` Sets the mode for the automatic calculation of the step unit.
`void`	`setAutoNumberFormat(boolean autoNumberFormat)` Toggles the automatic calculation of the number format.
`void`	`setAutoStepUnit(boolean auto)` Toggles the automatic calculation of the step unit.
`void`	`setAutoSubStepUnit(boolean auto)` Toggles the automatic calculation of the substep unit.
`void`	`setNumberFormat(NumberFormat fmt)` Specifies the format used to translate step values into labels.
`void`	`setStepUnit(double stepUnit)` Specifies the step unit.
`void`	`setSubStepCount(int count)` Sets the number of substeps.
`void`	`setSubStepUnit(double subStepUnit)` Specifies the substep unit.
`void`	`update()` Called before values are computed.

Methods inherited from class ilog.views.chart.IlvStepsDefinition
getLocale, getScale, getULocale, hasNext, localeChanged, nextStep, nextSubStep

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIMPLE_MODE
```
public static final int SIMPLE_MODE
```
    Type for simple automatic mode. When this mode is set, step units are computed with a simple algorithm that does not take into account the available space for step labels.
    
    See Also:
    
    setAutoMode(int), Constant Field Values
  - COMPLEX_MODE
```
public static final int COMPLEX_MODE
```
    Type for complex automatic mode. When this mode is set, step units are computed by taking into account the available space for step labels.
    
    See Also:
    
    setAutoMode(int), Constant Field Values
- Constructor Detail
  - IlvDefaultStepsDefinition
```
public IlvDefaultStepsDefinition()
```
    Creates a new IlvDefaultStepsDefinition that automatically computes the step and substep units.
  - IlvDefaultStepsDefinition
```
public IlvDefaultStepsDefinition(int mode)
```
    Creates a new IlvDefaultStepsDefinition that automatically computes the step and substep units with the specified mode.
    
    See Also:
    
    setAutoMode(int)
- Method Detail
  - isAutoNumberFormat
```
public final boolean isAutoNumberFormat()
```
    Indicates whether the number format is automatically computed.
    
    See Also:
    
    setAutoNumberFormat(boolean)
  - setAutoNumberFormat
```
public void setAutoNumberFormat(boolean autoNumberFormat)
```
    Toggles the automatic calculation of the number format. When this property is set to true, the format used to convert values into string is automatically computed.
    Note: The bean property "autoNumberFormat" must not be specified together with the bean property "numberFormat".
    
    See Also:
    
    isAutoNumberFormat(), setNumberFormat(java.text.NumberFormat)
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    Returns the format used to translate step values into labels.
    
    See Also:
    
    setNumberFormat(java.text.NumberFormat)
  - setNumberFormat
```
public void setNumberFormat(NumberFormat fmt)
```
    Specifies the format used to translate step values into labels. This method toggles off the automatic calculation of the number format.
    Note: setNumberFormat(null) sets the format to a locale dependent default format.
    Note: The bean property "numberFormat" must not be specified together with the bean property "autoNumberFormat".
    
    See Also:
    
    setAutoNumberFormat(boolean), getNumberFormat()
  - getAutoMode
```
public final int getAutoMode()
```
    Returns the mode for the automatic calculation of the step unit. The default mode is SIMPLE_MODE.
    
    See Also:
    
    SIMPLE_MODE, COMPLEX_MODE, setAutoStepUnit(boolean), setAutoMode(int)
  - setAutoMode
```
public void setAutoMode(int mode)
```
    Sets the mode for the automatic calculation of the step unit.
    
    See Also:
    
    SIMPLE_MODE, COMPLEX_MODE, setAutoStepUnit(boolean), getAutoMode()
  - isAutoStepUnit
```
public final boolean isAutoStepUnit()
```
    Indicates whether the step unit is automatically computed.
    
    See Also:
    
    setAutoStepUnit(boolean)
  - setAutoStepUnit
```
public void setAutoStepUnit(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.
    Note: The bean property "autoStepUnit" must not be specified together with the bean property "stepUnit".
    
    See Also:
    
    isAutoStepUnit(), setStepUnit(double)
  - isAutoSubStepUnit
```
public final boolean isAutoSubStepUnit()
```
    Indicates whether the substep unit is automatically computed.
    
    See Also:
    
    setAutoSubStepUnit(boolean)
  - setAutoSubStepUnit
```
public void setAutoSubStepUnit(boolean auto)
```
    Toggles the automatic calculation of the substep unit. When this property is set to true, the substep unit is automatically computed according to the step unit.
    Note: The bean property "autoSubStepUnit" must not be specified together with the bean properties "subStepUnit" or "subStepCount".
    
    See Also:
    
    setSubStepUnit(double)
  - getStepUnit
```
public final double getStepUnit()
```
    Returns the step unit.
    
    See Also:
    
    setStepUnit(double)
  - setStepUnit
```
public void setStepUnit(double stepUnit)
```
    Specifies the step unit. This method toggles off the automatic calculation of the step unit.
    Note: The bean property "stepUnit" must not be specified together with the bean property "autoStepUnit".
    
    See Also:
    
    isAutoStepUnit(), getStepUnit()
  - hasSubStep
```
public boolean hasSubStep()
```
    Indicates whether this object defines substeps. Returns true if the substep unit is strictly greater than 0.
    
    Overrides:
    
    hasSubStep in class IlvStepsDefinition
  - getSubStepUnit
```
public final double getSubStepUnit()
```
    Returns the substep unit.
    
    See Also:
    
    setSubStepUnit(double), setSubStepCount(int)
  - setSubStepUnit
```
public void setSubStepUnit(double subStepUnit)
```
    Specifies the substep 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".
    
    See Also:
    
    isAutoSubStepUnit(), getSubStepUnit()
  - getSubStepCount
```
public int getSubStepCount()
```
    Returns the number of substeps.
    
    Since:
    
    JViews 5.5
    
    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.
    Note: The bean property "subStepCount" must not be specified together with the bean properties "autoSubStepUnit" or "subStepUnit".
    
    Since:
    
    JViews 5.5
  - update
```
public void update()
```
    Called before values are computed. This method computes the step and substeps unit if the corresponding automatic modes have been enabled.
    
    Overrides:
    
    update in class IlvStepsDefinition
    
    See Also:
    
    setAutoStepUnit(boolean), setAutoSubStepUnit(boolean)
  - computeStepUnit
```
protected double computeStepUnit()
```
    Invoked to compute the step unit when the automatic mode is enabled.
    
    See Also:
    
    setAutoStepUnit(boolean)
  - computeLabel
```
public String computeLabel(double value)
```
    Computes the label associated to the specified value. This method uses the format specified by the setNumberFormat(java.text.NumberFormat) method.
    
    Specified by:
    
    computeLabel in class IlvStepsDefinition
    
    Parameters:
    
    value - Numeric coordinate value.
    
    Returns:
    
    A label denoting this value.
  - previousStep
```
public double previousStep(double v)
```
    Returns the step value immediately before the specified value.
    
    Specified by:
    
    previousStep in class IlvStepsDefinition
  - incrementStep
```
public double incrementStep(double v)
```
    Returns the next step value.
    
    Specified by:
    
    incrementStep in class IlvStepsDefinition
  - previousSubStep
```
public double previousSubStep(double v)
```
    Returns the substep value immediately before the specified value.
    
    Overrides:
    
    previousSubStep in class IlvStepsDefinition
    
    See Also:
    
    IlvStepsDefinition.hasSubStep()
  - incrementSubStep
```
public double incrementSubStep(double v)
```
    Returns the next substep value.
    
    Overrides:
    
    incrementSubStep in class IlvStepsDefinition
    
    See Also:
    
    IlvStepsDefinition.hasSubStep()
  - adjustRange
```
public static void adjustRange(IlvDataInterval range)
```
    Adjusts the specified range so that its limits are snapped to unit values. The considered unit is computed by the same algorithm used by the SIMPLE_MODE mode.

Class IlvDefaultStepsDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ilog.views.chart.IlvStepsDefinition

Methods inherited from class java.lang.Object

Field Detail

SIMPLE_MODE

COMPLEX_MODE

Constructor Detail

IlvDefaultStepsDefinition

IlvDefaultStepsDefinition

Method Detail

isAutoNumberFormat

setAutoNumberFormat

getNumberFormat

setNumberFormat

getAutoMode

setAutoMode

isAutoStepUnit

setAutoStepUnit

isAutoSubStepUnit

setAutoSubStepUnit

getStepUnit

setStepUnit

hasSubStep

getSubStepUnit

setSubStepUnit

getSubStepCount

setSubStepCount

update

computeStepUnit

computeLabel

previousStep

incrementStep

previousSubStep

incrementSubStep

adjustRange