info.monitorenter.gui.chart
Interface IRangePolicy

All Superinterfaces:

Serializable

All Known Implementing Classes:

ARangePolicy, RangePolicyFixedViewport, RangePolicyForcedPoint, RangePolicyHighestValues, RangePolicyHighestValuesForcedMin, RangePolicyMinimumViewport, RangePolicyUnbounded

public interface IRangePolicy
extends Serializable

An interface that allows an axis to be plugged with a range policy.

Implementations may limit the range of the underlying Chart2D's data (clipping / zooming), increase it (void space offset), guarantee a minimum viewport... .

Property Change events

property	oldValue	newValue	occurance
PROPERTY_RANGE	Range that changed	Range, the new value	Fired if any bound of the range changed (min or max).
PROPERTY_RANGE_MAX	Double, the old max value of the range.	Range, the new max value of the range.
PROPERTY_RANGE_MIN	Double, the old min value of the range.	Range, the new min value of the range.

Version:

$Revision: 1.6 $

Author:

Achim Westermann

See Also:

AAxis

Field Summary

static String	PROPERTY_RANGE The property key defining a change of the min or the max property.
static String	PROPERTY_RANGE_MAX The property key defining the max property.
static String	PROPERTY_RANGE_MIN The property key defining the min property.

Method Summary

void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Registers a property change listener that will be informed about changes of the property identified by the given propertyName.
double	getMax(double chartMin, double chartMax) Define the upper bound of the Chart2D's value range.
double	getMin(double chartMin, double chartMax) Define the lower bound of the Chart2D's value range.
PropertyChangeListener[]	getPropertyChangeListeners(String property) Returns all property change listeners for the given property.
Range	getRange() Get the range of this range policy.
void	removePropertyChangeListener(PropertyChangeListener listener, String property) Deregisters a property change listener that has been registerd for listening on the given property.
void	removePropertyChangeListener(String property, PropertyChangeListener listener) Removes a property change listener for listening on the given property.
void	setRange(Range range) Set the range of this RangePolicy.

Field Detail

PROPERTY_RANGE

static final String PROPERTY_RANGE

The property key defining a change of the min or the max property.

Use in combination with addPropertyChangeListener(String, PropertyChangeListener).

See Also:

Constant Field Values

PROPERTY_RANGE_MAX

static final String PROPERTY_RANGE_MAX

The property key defining the max property.

Use in combination with addPropertyChangeListener(String, PropertyChangeListener).

See Also:

Constant Field Values

PROPERTY_RANGE_MIN

static final String PROPERTY_RANGE_MIN

The property key defining the min property.

Use in combination with addPropertyChangeListener(String, PropertyChangeListener).

See Also:

Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

Registers a property change listener that will be informed about changes of the property identified by the given propertyName.

Parameters:

propertyName - the name of the property the listener is interested in

listener - a listener that will only be informed if the property identified by the argument propertyName changes

getMax

double getMax(double chartMin,
              double chartMax)

Define the upper bound of the Chart2D's value range. Depends on the AAxis this instance is bound to.

Parameters:

chartMin - the minimum value of the connected Chart2D that may / should be taken into account.

chartMax - the maximum value of the connected Chart2D that may / should be taken into account.

Returns:

the maximum value (upper bound) for the Chart2D to display.

getMin

double getMin(double chartMin,
              double chartMax)

Define the lower bound of the Chart2D's value range. Depends on the AAxis this instance is bound to.

Parameters:

chartMin - the minimum value of the connected Chart2D that may / should be taken into account.

chartMax - the maximum value of the connected Chart2D that may / should be taken into account.

Returns:

the minimum value (lower bound) for the Chart2D to display.

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners(String property)

Returns all property change listeners for the given property.

Parameters:

property - one of the constants with teh PROPERTY_ prefix defined in this class or subclasses.

Returns:

the property change listeners for the given property.

getRange

Range getRange()

Get the range of this range policy.

Returns:

he range of this range policy

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener,
                                  String property)

Deregisters a property change listener that has been registerd for listening on the given property.

Parameters:

listener - a listener that will only be informed if the property identified by the argument propertyName changes

property - the property the listener was registered to.

removePropertyChangeListener

void removePropertyChangeListener(String property,
                                  PropertyChangeListener listener)

Removes a property change listener for listening on the given property.

Parameters:

property - one of the constants with teh PROPERTY_ prefix defined in this class or subclasses.

listener - the listener for this property change.

setRange

void setRange(Range range)

Set the range of this RangePolicy.

Parameters:

range - the Range for the range policy.