ilog.views.chart.interactor

Class IlvChartHighlightInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataInteractor

ilog.views.chart.interactor.IlvChartHighlightInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvChartInfoViewInteractor

public class IlvChartHighlightInteractor
extends IlvChartDataInteractor

An interactor that notifies the listeners when the mouse cursor is over a point.

The registered name of this interactor is "Highlight".

Since:

JViews 5.0

See Also:

IlvChartInteractor, Serialized Form

Nested Class Summary

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

IlvChartDataInteractor.DataPicker

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHLIGHT_POINT Highlight mode used to highlight points.
static int	HIGHLIGHT_SERIES Highlight mode used to highlight data sets.

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
IlvChartHighlightInteractor() Creates a new IlvChartHighlightInteractor object linked to the first Y-axis index.
IlvChartHighlightInteractor(int yAxisIndex) Creates a new IlvChartHighlightInteractor object linked to the given axis.

Method Summary

Modifier and Type	Method and Description
protected void	doIt(IlvDisplayPoint highlightedPoint, boolean isHighlighted, MouseEvent event) Called by the processXXXEvent() methods when the highlight state of the given point has changed.
IlvDisplayPoint	getHighlightedPoint() Returns the current highlighted point.
int	getHighlightMode() Returns the highlight mode.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
boolean	isHandling(int x, int y) Returns whether the mouse event occurred at the specified location should be handled by the interactor.
void	processMouseEvent(MouseEvent event) Processes a mouse event.
void	processMouseMotionEvent(MouseEvent event) Processes a mouse motion event.
void	processMouseMovedEvent(MouseEvent event) Processes a mouse motion event with no button pressed.
void	setHighlightedPoint(IlvDisplayPoint point) Sets the current highlighted point.
void	setHighlightMode(int highlightMode) Sets the highlight mode.

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

createDataPicker, getPickingMode, pickData, pickData, setPickingMode

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

HIGHLIGHT_POINT

public static final int HIGHLIGHT_POINT

Highlight mode used to highlight points.

Since:

JViews 5.5

See Also:

setHighlightMode(int), Constant Field Values

HIGHLIGHT_SERIES

public static final int HIGHLIGHT_SERIES

Highlight mode used to highlight data sets.

Since:

JViews 5.5

See Also:

setHighlightMode(int), Constant Field Values

Constructor Detail

IlvChartHighlightInteractor

public IlvChartHighlightInteractor()

Creates a new IlvChartHighlightInteractor object linked to the first Y-axis index.

IlvChartHighlightInteractor

public IlvChartHighlightInteractor(int yAxisIndex)

Creates a new IlvChartHighlightInteractor object linked to the given axis.

Method Detail

getLocalizedName

public static String getLocalizedName(Locale locale)

Returns a localized name for this interactor class.

Since:

JViews 7.5

getHighlightMode

public int getHighlightMode()

Returns the highlight mode.

Since:

JViews 5.5

See Also:

setHighlightMode(int)

setHighlightMode

public void setHighlightMode(int highlightMode)

Sets the highlight mode.

Parameters:

highlightMode - The highlight mode. If set to HIGHLIGHT_POINT, a pair of highlight and unhighlight events is sent whenever the mouse enters and leaves a display point. If set to HIGHLIGHT_SERIES, the highlight and unhighlight events are sent only if the new display point does not belong to the same data set as the previously highlighted point. The default mode is HIGHLIGHT_POINT.

Throws:

IllegalArgumentException - The mode is invalid.

Since:

JViews 5.5

See Also:

getHighlightMode()

getHighlightedPoint

public IlvDisplayPoint getHighlightedPoint()

Returns the current highlighted point.

setHighlightedPoint

public void setHighlightedPoint(IlvDisplayPoint point)

Sets the current highlighted point.

Since:

JViews 5.5

isHandling

public boolean isHandling(int x,
                          int y)

Returns whether the mouse event occurred at the specified location should be handled by the interactor. By default, returns true.

Overrides:

isHandling in class IlvChartInteractor

processMouseEvent

public void processMouseEvent(MouseEvent event)

Processes a mouse event.

Overrides:

processMouseEvent in class IlvChartInteractor

processMouseMotionEvent

public void processMouseMotionEvent(MouseEvent event)

Processes a mouse motion event.

Overrides:

processMouseMotionEvent in class IlvChartInteractor

processMouseMovedEvent

public void processMouseMovedEvent(MouseEvent event)

Processes a mouse motion event with no button pressed.

Parameters:

event - An event of type MOUSE_MOVED or MOUSE_ENTERED.

Since:

JViews 8.5

doIt

protected void doIt(IlvDisplayPoint highlightedPoint,
                    boolean isHighlighted,
                    MouseEvent event)

Called by the processXXXEvent() methods when the highlight state of the given point has changed. By default, fires a ChartHighlightInteractionEvent.

Parameters:

highlightedPoint - The display point.

isHighlighted - The type of notification that occurred.

event - The mouseEvent that leads to this notification.

See Also:

IlvChartInteractor.addChartInteractionListener(ilog.views.chart.event.ChartInteractionListener), ChartInteractionEvent