IlvStepsDefinition (Rogue Wave JViews 9.1 API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvCategoryStepsDefinition, IlvDefaultStepsDefinition, IlvLogarithmicStepsDefinition, IlvTimeStepsDefinition
```
public abstract class IlvStepsDefinition
extends Object
implements Serializable
```
Defines how scale steps values are computed. This class provides the necessary methods to compute the values associated with scale steps and substeps. It also defines the formatting between values and labels. The IlvScale.setStepsDefinition(ilog.views.chart.IlvStepsDefinition) method lets you associate an IlvStepsDefinition object with a scale.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlvStepsDefinition()
Creates a new IlvStepsDefinition.

Constructors
Modifier	Constructor and Description
`protected`	`IlvStepsDefinition()` Creates a new `IlvStepsDefinition`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract String`	`computeLabel(double value)` Computes the label associated with the specified value.
`Locale`	`getLocale()` Returns the current locale.
`IlvScale`	`getScale()` Returns the scale using this steps definition.
`ULocale`	`getULocale()` Returns the current locale.
`boolean`	`hasNext(double value)` Indicates whether this object defines a step after the specified value.
`boolean`	`hasSubStep()` Indicates whether this object defines substeps.
`abstract double`	`incrementStep(double v)` Increments the specified step.
`double`	`incrementSubStep(double v)` Increments the specified substep.
`void`	`localeChanged()` This method is invoked when the current locale has changed.
`double`	`nextStep(double v)` Returns the step value immediately after the specified value.
`double`	`nextSubStep(double v)` Returns the substep value immediately after the specified value.
`abstract 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`	`update()` Called by the scale before it computes the step values.

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

- Constructor Detail
  - IlvStepsDefinition
```
protected IlvStepsDefinition()
```
    Creates a new IlvStepsDefinition.
- Method Detail
  - getScale
```
public final IlvScale getScale()
```
    Returns the scale using this steps definition. This method returns null until the definition is connected to a scale with the IlvScale.setStepsDefinition(ilog.views.chart.IlvStepsDefinition) method.
  - update
```
public void update()
```
    Called by the scale before it computes the step values. The default implementation does nothing. This method should be overridden by subclasses that need to prepare the steps definition before the scale uses it.
  - hasNext
```
public boolean hasNext(double value)
```
    Indicates whether this object defines a step after the specified value. The default implementation returns true.
    
    Parameters:
    
    value - The considered value.
    
    Returns:
    
    true if a step exists after value, and false otherwise.
    
    Since:
    
    JViews 5.5
  - previousStep
```
public abstract double previousStep(double v)
```
    Returns the step value immediately before the specified value.
  - nextStep
```
public double nextStep(double v)
```
    Returns the step value immediately after the specified value.
    This method is equivalent to: incrementStep(previousStep(v)).
    
    See Also:
    
    incrementStep(double), previousStep(double)
  - incrementStep
```
public abstract double incrementStep(double v)
```
    Increments the specified step.
  - hasSubStep
```
public boolean hasSubStep()
```
    Indicates whether this object defines substeps. The default implementation returns false. Subclasses can override this method and provide implementation for previousSubStep(double) and incrementSubStep(double).
  - previousSubStep
```
public double previousSubStep(double v)
```
    Returns the substep value immediately before the specified value. As IlvStepsDefinition does not define substeps by default, this method simply returns the specified value.
    
    See Also:
    
    hasSubStep()
  - nextSubStep
```
public double nextSubStep(double v)
```
    Returns the substep value immediately after the specified value.
    This method is equivalent to: incrementSubStep(previousSubStep(v)).
    
    See Also:
    
    incrementSubStep(double), previousSubStep(double)
  - incrementSubStep
```
public double incrementSubStep(double v)
```
    Increments the specified substep.
    As IlvStepsDefinition does not define substeps by default, this method simply returns the specified value.
    
    See Also:
    
    hasSubStep()
  - getULocale
```
public ULocale getULocale()
```
    Returns the current locale.
    
    Returns:
    
    The locale that is used for formatting purposes by this instance.
    
    Since:
    
    JViews 8.8
  - getLocale
```
public final Locale getLocale()
```
    Returns the current locale.
    
    Returns:
    
    The locale that is used for formatting purposes by this instance.
    
    Since:
    
    JViews 8.8
  - 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.
    
    Since:
    
    JViews 8.8
  - computeLabel
```
public abstract String computeLabel(double value)
```
    Computes the label associated with the specified value.
    This method must take account of the current locale, that you can determine with a getULocale() or (@link #getLocale()} call.
    
    Parameters:
    
    value - Numeric coordinate value.
    
    Returns:
    
    A label denoting this value.

Class IlvStepsDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvStepsDefinition

Method Detail

getScale

update

hasNext

previousStep

nextStep

incrementStep

hasSubStep

previousSubStep

nextSubStep

incrementSubStep

getULocale

getLocale

localeChanged

computeLabel