ilog.views.chart.interactor

Class IlvChartScrollInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartScrollInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvChartXScrollInteractor, IlvChartYScrollInteractor

public abstract class IlvChartScrollInteractor
extends IlvChartInteractor

An abstract class that defines an interface to handle the scrolling of an axis by using the keyboard.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEGATIVE_DIR Describes a scroll in the negative direction.
static int	POSITIVE_DIR Describes a scroll in the positive direction.

Fields inherited from class ilog.views.chart.IlvChartInteractor

INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors

Constructor and Description
IlvChartScrollInteractor(int negativeDirKey, int positiveDirKey, int step) Creates a new IlvChartScrollInteractor object.
IlvChartScrollInteractor(int yAxisIndex, int negativeDirKey, int positiveDirKey, int step) Creates a new IlvChartScrollInteractor object.

Method Summary

Modifier and Type	Method and Description
protected abstract IlvAxis	getAxis() Returns the axis scrolled by this interactor
protected double	getDelta() Returns the delta value (in data) of the scroll.
int	getNegativeDirectionKey() Returns the key associated with a scroll in the negative direction.
int	getPositiveDirectionKey() Returns the key associated with a scroll in the positive direction.
int	getStep() Returns the scrolling step.
void	processKeyEvent(KeyEvent event) Handles the key events.
protected abstract void	scroll(int Direction) Called when a scroll is performed in the given direction.
void	setNegativeDirectionKey(int key) Sets the key associated with a scroll in the negative direction.
void	setPositiveDirectionKey(int key) Sets the key associated with a scroll in the positive direction.
void	setStep(int step) Sets the number of scale step to scroll or the percentage of the visible range to scroll, whether a steps definition for the scrolled axis is available.

Methods inherited from class ilog.views.chart.IlvChartInteractor

abort, addChartInteractionListener, chartConnected, create, create, disableEvents, drawGhost, drawGhost, enableEvents, endOperation, fireChartInteractionEvent, getAWTEventMask, getChart, getCoordinateSystem, getData, getData, getEventMask, getEventMaskEx, getGhostBounds, getGhostColor, getInteractorClassByName, getLocalizedName, getPriority, getRegisteredInteractorsByName, getShortName, getXAxis, getXORColor, getYAxis, getYAxisIndex, handleExpose, has3DSupport, initGhostGraphics, interactionStarted, isAborted, isAllowDrawGhost, isConsumeEvents, isHandling, isInOperation, isXORGhost, processMouseEvent, processMouseMotionEvent, register, removeChartInteractionListener, setAborted, setAllowDrawGhost, setChart, setConsumeEvents, setCursor, setEventMask, setGhostColor, setInOperation, setPriority, setXORColor, setXORGhost, setYAxisIndex, startOperation, toDisplay

Methods inherited from class java.lang.Object

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

Field Detail

POSITIVE_DIR

public static final int POSITIVE_DIR

Describes a scroll in the positive direction.

See Also:

Constant Field Values

NEGATIVE_DIR

public static final int NEGATIVE_DIR

Describes a scroll in the negative direction.

See Also:

Constant Field Values

Constructor Detail

IlvChartScrollInteractor

public IlvChartScrollInteractor(int negativeDirKey,
                                int positiveDirKey,
                                int step)

Creates a new IlvChartScrollInteractor object.

Parameters:

negativeDirKey - The key associated with a scroll in the negative direction.

positiveDirKey - The key associated with a scroll in the positive direction.

step - The number of steps to scroll or the percentage of the visible range to scroll whether a steps definition for the scrolled axis is available.

IlvChartScrollInteractor

public IlvChartScrollInteractor(int yAxisIndex,
                                int negativeDirKey,
                                int positiveDirKey,
                                int step)

Creates a new IlvChartScrollInteractor object.

Parameters:

yAxisIndex - The Y-axis index.

negativeDirKey - The key associated with a scroll in the negative direction.

positiveDirKey - The key associated with a scroll in the positive direction.

step - The number of steps to scroll or the percentage of the visible range to scroll, whether a steps definition for the scrolled axis is available.

Method Detail

getPositiveDirectionKey

public final int getPositiveDirectionKey()

Returns the key associated with a scroll in the positive direction.

setPositiveDirectionKey

public final void setPositiveDirectionKey(int key)

Sets the key associated with a scroll in the positive direction.

getNegativeDirectionKey

public final int getNegativeDirectionKey()

Returns the key associated with a scroll in the negative direction.

setNegativeDirectionKey

public final void setNegativeDirectionKey(int key)

Sets the key associated with a scroll in the negative direction.

getStep

public final int getStep()

Returns the scrolling step.

See Also:

setStep(int)

setStep

public final void setStep(int step)

Sets the number of scale step to scroll or the percentage of the visible range to scroll, whether a steps definition for the scrolled axis is available.

processKeyEvent

public void processKeyEvent(KeyEvent event)

Handles the key events.

Overrides:

processKeyEvent in class IlvChartInteractor

getAxis

protected abstract IlvAxis getAxis()

Returns the axis scrolled by this interactor

scroll

protected abstract void scroll(int Direction)

Called when a scroll is performed in the given direction.

getDelta

protected double getDelta()

Returns the delta value (in data) of the scroll. This method should be called by subclasses in their scroll() method to get the amount of data to scroll.

See Also:

scroll(int)