ilog.views.chart
Class IlvDefaultStepsDefinition

ilog.views.chart.IlvStepsDefinition
      ilog.views.chart.IlvDefaultStepsDefinition

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.

CSS example:

ilvDefaultStepsDefinition {
class : "ilog.views.chart.IlvDefaultStepsDefinition";
autoMode : "SIMPLE_MODE";
autoNumberFormat : "false";
autoStepUnit : "false";
autoSubStepUnit : "false";
numberFormat : "@#numberFormat";
stepUnit : "3.0";
subStepCount : "2";
subStepUnit : "3.0";
}

Property Summary

int	autoMode Sets the mode for the automatic calculation of the step unit.
boolean	autoNumberFormat Toggles the automatic calculation of the number format.
boolean	autoStepUnit Toggles the automatic calculation of the step unit.
boolean	autoSubStepUnit Toggles the automatic calculation of the substep unit.
java.lang.String	class Creates a new IlvDefaultStepsDefinition that automatically computes the step and substep units.
java.text.NumberFormat	numberFormat Specifies the format used to translate step values into labels.
double	stepUnit Specifies the step unit.
int	subStepCount Sets the number of substeps.
double	subStepUnit Specifies the substep unit.

Property Detail

class

public java.lang.String class

Creates a new IlvDefaultStepsDefinition that automatically computes the step and substep units.

CSS example: class : "ilog.views.chart.IlvDefaultStepsDefinition";

autoMode

public int autoMode

Sets the mode for the automatic calculation of the step unit.

CSS example: autoMode : "SIMPLE_MODE";

Allowed values:
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.
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:

autoStepUnit

autoNumberFormat

public 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".

CSS example: autoNumberFormat : "false";

autoStepUnit

public boolean autoStepUnit

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".

CSS example: autoStepUnit : "false";

autoSubStepUnit

public boolean autoSubStepUnit

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".

CSS example: autoSubStepUnit : "false";

numberFormat

public java.text.NumberFormat numberFormat

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".

CSS example: numberFormat : "@#numberFormat";

See implementing class NumberFormat for an example of implementing a numberFormat.

stepUnit

public 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".

CSS example: stepUnit : "3.0";

subStepCount

public int subStepCount

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".

CSS example: subStepCount : "2";

subStepUnit

public 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".

CSS example: subStepUnit : "3.0";

See Also:

subStepCount