ilog.views.chart.interactor

Class IlvChartDataInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvChartEditPointInteractor, IlvChartHighlightInteractor, IlvChartPickInteractor, IlvTreemapChartFocusInteractor

public abstract class IlvChartDataInteractor
extends IlvChartInteractor

The abstract base class for chart data manipulation. This class provides an interface for querying information about the data in a chart according to a given IlvChartDataPicker.

Since:

JViews 5.0

See Also:

IlvChartInteractor, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IlvChartDataInteractor.DataPicker An IlvDefaultChartDataPicker subclass which filters the renderers according to the interactor y-axis index.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ITEM_PICKING The constant describing the precise item picking mode.
static int	NEARESTITEM_PICKING The constant describing the nearest item picking mode.
static int	NEARESTPOINT_PICKING The constant describing the nearest point picking mode.

Fields inherited from class ilog.views.chart.IlvChartInteractor

INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors

Constructor and Description
IlvChartDataInteractor(int yAxisIndex, int eventMask) Creates a new IlvChartDataInteractor object associated with the given axis with the given action key event mask.

Method Summary

Modifier and Type	Method and Description
protected IlvChartDataPicker	createDataPicker(MouseEvent event) Creates a new IlvChartDataPicker object.
int	getPickingMode() Returns the picking mode.
protected IlvDisplayPoint	pickData(IlvChartDataPicker picker) Returns a display point depending on the given data picker and the current picking mode.
protected IlvDisplayPoint	pickData(MouseEvent event) Returns a display point corresponding to this picking event that fulfills the default data picker criteria.
void	setPickingMode(int mode) Sets the interactor picking mode.

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, processKeyEvent, 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

ITEM_PICKING

public static final int ITEM_PICKING

The constant describing the precise item picking mode.

See Also:

setPickingMode(int), IlvChart.getDisplayItem(ilog.views.chart.IlvChartDataPicker), Constant Field Values

NEARESTITEM_PICKING

public static final int NEARESTITEM_PICKING

The constant describing the nearest item picking mode.

Since:

JViews 8.5

See Also:

setPickingMode(int), IlvChart.getNearestItem(ilog.views.chart.IlvChartDataPicker, double[]), Constant Field Values

NEARESTPOINT_PICKING

public static final int NEARESTPOINT_PICKING

The constant describing the nearest point picking mode.

See Also:

setPickingMode(int), IlvChart.getNearestPoint(ilog.views.chart.IlvChartDataPicker), Constant Field Values

Constructor Detail

IlvChartDataInteractor

public IlvChartDataInteractor(int yAxisIndex,
                              int eventMask)

Creates a new IlvChartDataInteractor object associated with the given axis with the given action key event mask.

Method Detail

getPickingMode

public final int getPickingMode()

Returns the picking mode.

See Also:

setPickingMode(int)

setPickingMode

public void setPickingMode(int mode)

Sets the interactor picking mode. The picking mode defines how a point is retrieved by the pickData() method. If the mode is ITEM_PICKING, the display point is retrieved by calling IlvChart.getDisplayItem(ilog.views.chart.IlvChartDataPicker). If the mode is NEARESTITEM_PICKING, the display point is retrieved by calling IlvChart.getNearestItem(ilog.views.chart.IlvChartDataPicker, double[]). If the mode is NEARESTPOINT_PICKING, the display point is retrieved by calling IlvChart.getNearestPoint(ilog.views.chart.IlvChartDataPicker). The default value is NEARESTPOINT_PICKING.

See Also:

ITEM_PICKING, NEARESTITEM_PICKING, NEARESTPOINT_PICKING, pickData(java.awt.event.MouseEvent)

createDataPicker

protected IlvChartDataPicker createDataPicker(MouseEvent event)

Creates a new IlvChartDataPicker object. By default returns an instance of IlvChartDataInteractor.DataPicker. This method is called by pickData(MouseEvent).

See Also:

IlvDefaultChartDataPicker

pickData

protected final IlvDisplayPoint pickData(MouseEvent event)

Returns a display point corresponding to this picking event that fulfills the default data picker criteria. This method calls pickData(IlvChartDataPicker).

pickData

protected IlvDisplayPoint pickData(IlvChartDataPicker picker)

Returns a display point depending on the given data picker and the current picking mode.

See Also:

IlvChartDataPicker, setPickingMode(int)