ilog.views.chart.interactor

Class IlvChartPickInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataInteractor

ilog.views.chart.interactor.IlvChartPickInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

public class IlvChartPickInteractor
extends IlvChartDataInteractor

An interactor that fires an event when a point is picked. The mouse event that fires the callbacks is determined according to the isPickingEvent() method, the picked point being memorized on a MOUSE_PRESSED event. By default, the picked point is retrieved using the getDisplayItem() method (see IlvChartDataInteractor.setPickingMode(int)).

The registered name of this interactor is "Pick".

Since:

JViews 5.0

See Also:

IlvChartDataInteractor, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.chart.interactor.IlvChartDataInteractor

IlvChartDataInteractor.DataPicker

Field Summary

Fields inherited from class ilog.views.chart.interactor.IlvChartDataInteractor

ITEM_PICKING, NEARESTITEM_PICKING, NEARESTPOINT_PICKING

Fields inherited from class ilog.views.chart.IlvChartInteractor

INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors

Constructor and Description
IlvChartPickInteractor() Creates a new IlvChartPickInteractor associated with the Y-axis of index 0 and with the BUTTON1 mouse button.
IlvChartPickInteractor(int yAxisIdx, int pickButtonEventMask) Creates a new IlvChartPickInteractor associated with the given axis and with the given mouse button.

Method Summary

Modifier and Type	Method and Description
protected void	abort() Called when the interaction has been aborted.
protected void	endOperation(MouseEvent event) Called when the interaction ends.
protected Cursor	getCursor() Returned the cursor used by the interactor.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
protected boolean	isPickingEvent(MouseEvent event) Returns whether the given event is a picking event.
protected void	pick(IlvDisplayPoint pickedPoint) Called when a point has been picked.
void	processKeyEvent(KeyEvent event) Handles the key events.
void	processMouseEvent(MouseEvent event) Handles the mouse events.
protected void	startOperation(MouseEvent event) Called when the interaction starts.

Methods inherited from class ilog.views.chart.interactor.IlvChartDataInteractor

createDataPicker, getPickingMode, pickData, pickData, setPickingMode

Methods inherited from class ilog.views.chart.IlvChartInteractor

addChartInteractionListener, chartConnected, create, create, disableEvents, drawGhost, drawGhost, enableEvents, 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, processMouseMotionEvent, register, removeChartInteractionListener, setAborted, setAllowDrawGhost, setChart, setConsumeEvents, setCursor, setEventMask, setGhostColor, setInOperation, setPriority, setXORColor, setXORGhost, setYAxisIndex, toDisplay

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvChartPickInteractor

public IlvChartPickInteractor()

Creates a new IlvChartPickInteractor associated with the Y-axis of index 0 and with the BUTTON1 mouse button.

IlvChartPickInteractor

public IlvChartPickInteractor(int yAxisIdx,
                              int pickButtonEventMask)

Creates a new IlvChartPickInteractor associated with the given axis and with the given mouse button.

Method Detail

getLocalizedName

public static String getLocalizedName(Locale locale)

Returns a localized name for this interactor class.

Since:

JViews 7.5

getCursor

protected Cursor getCursor()

Returned the cursor used by the interactor. By default, returns the predefined Cursor.HAND_CURSOR awt cursor.

isPickingEvent

protected boolean isPickingEvent(MouseEvent event)

Returns whether the given event is a picking event. A picking event is defined as the event that fires a ChartInteractionEvent to all the listeners. By default, returns true if the event is a MOUSE_RELEASED event.

processMouseEvent

public void processMouseEvent(MouseEvent event)

Handles the mouse events.

Overrides:

processMouseEvent in class IlvChartInteractor

processKeyEvent

public void processKeyEvent(KeyEvent event)

Handles the key events.

Overrides:

processKeyEvent in class IlvChartInteractor

pick

protected void pick(IlvDisplayPoint pickedPoint)

Called when a point has been picked. The default implementation fires a chartInteractorEvent. see #isPickingEvent

startOperation

protected void startOperation(MouseEvent event)

Called when the interaction starts. You may override this method to add your own initialization code.

Overrides:

startOperation in class IlvChartInteractor

Parameters:

event - The event that starts the interaction.

See Also:

IlvChartInteractor.interactionStarted(ilog.views.chart.IlvChartInteractor, java.awt.event.MouseEvent)

endOperation

protected void endOperation(MouseEvent event)

Called when the interaction ends. You may override this method to add your own initialization code.

Overrides:

endOperation in class IlvChartInteractor

Parameters:

event - The event that ends the interaction.

abort

protected void abort()

Called when the interaction has been aborted. You may override this method to add your own initialization code.

Overrides:

abort in class IlvChartInteractor