ilog.views.chart.event

Class AxisRangeEvent

java.lang.Object

java.util.EventObject

ilog.views.chart.event.AxisEvent

ilog.views.chart.event.AxisRangeEvent

All Implemented Interfaces:

Serializable

public class AxisRangeEvent
extends AxisEvent

The AxisRangeEvent class describes changes in the data range or the visible range of an IlvAxis.

When the range is modified, a pre-notification (see isAboutToChangeEvent()) is sent to all the listeners to specify what will be the new range. At this time, listeners have the possibility to modify the new range (for example to implement a range filter) using the setNewMin(double) and setNewMax(double) methods. Then, the axis range is modified to the event range value, and a second notification is sent (see isChangedEvent()) to notify listeners of the final range.

Since:

JViews 5.0

See Also:

AxisListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AxisRangeEvent(IlvAxis axis, IlvDataInterval range, boolean aboutToChange, boolean isAdjusting, boolean visibleRange) Creates a new event.

Method Summary

Modifier and Type	Method and Description
double	getNewMax() Returns the new maximum bound.
double	getNewMin() Returns the new minimum bound.
double	getOldMax() Returns the previous maximum bound.
double	getOldMin() Returns the previous minimum bound.
IlvDataInterval	getStoredRange() Returns the range that is stored as non-redundant information in this event.
boolean	isAboutToChangeEvent() Returns whether the range is about to be changed.
boolean	isChangedEvent() Returns whether the range has already been changed.
boolean	isScrollEvent() Returns whether this event is a scroll event.
boolean	isVisibleRangeEvent() Indicates whether this event describes a change in the visible range.
void	setNewMax(double max) Sets the new maximum bound.
void	setNewMin(double min) Sets the new minimum bound.

Methods inherited from class ilog.views.chart.event.AxisEvent

getAxis, isAdjusting

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AxisRangeEvent

public AxisRangeEvent(IlvAxis axis,
                      IlvDataInterval range,
                      boolean aboutToChange,
                      boolean isAdjusting,
                      boolean visibleRange)

Creates a new event.

Parameters:

axis - The considered axis.

range - The new range if the change has not yet occurred, or the previous range if the change already occurred.

aboutToChange - A boolean value indicating whether the change already occurred.

isAdjusting - A boolean value indicating whether the event is part of a series of several events.

visibleRange - If true, the event describes a change in the visible range of the axis. Otherwise, the event describes a change in the data range of the axis.

Method Detail

getOldMin

public double getOldMin()

Returns the previous minimum bound.

getOldMax

public double getOldMax()

Returns the previous maximum bound.

setNewMin

public void setNewMin(double min)

Sets the new minimum bound. This method is only meaningful when the event is an aboutToChangeEvent.

getNewMin

public double getNewMin()

Returns the new minimum bound.

setNewMax

public void setNewMax(double max)

Sets the new maximum bound. This method is only meaningful when the event is an aboutToChangeEvent.

getNewMax

public double getNewMax()

Returns the new maximum bound.

getStoredRange

public IlvDataInterval getStoredRange()

Returns the range that is stored as non-redundant information in this event. Its meaning depends on the type of this event.

Since:

JViews 8.7

isVisibleRangeEvent

public final boolean isVisibleRangeEvent()

Indicates whether this event describes a change in the visible range.

Returns:

true if this event describes a change in the visible range, and false if it describes a change in the data range.

See Also:

IlvAxis.getVisibleRange(), IlvAxis.getDataRange()

isAboutToChangeEvent

public final boolean isAboutToChangeEvent()

Returns whether the range is about to be changed.

isChangedEvent

public final boolean isChangedEvent()

Returns whether the range has already been changed.

isScrollEvent

public final boolean isScrollEvent()

Returns whether this event is a scroll event.