ilog.views.chart.interactor

Class IlvChartInfoViewInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataInteractor

ilog.views.chart.interactor.IlvChartHighlightInteractor

ilog.views.chart.interactor.IlvChartInfoViewInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvScheduleInfoViewInteractor

public class IlvChartInfoViewInteractor
extends IlvChartHighlightInteractor

An interactor that displays an information tooltip when the mouse cursor is over a chart point.

The registered name of this interactor is "InfoView".

Since:

JViews 5.0

See Also:

IlvChartHighlightInteractor, 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.IlvChartHighlightInteractor

HIGHLIGHT_POINT, HIGHLIGHT_SERIES

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

Method Summary

Modifier and Type	Method and Description
protected Point	adjustPosition(Point point, Dimension size, Rectangle rootBounds) Adjusts the tooltip location so that it fits into the root component area.
protected Point	computePosition(Dimension tooltipSize, int x, int y) Computes the tooltip location.
protected JToolTip	createToolTip() Creates a new JToolTip instance.
protected void	doIt(IlvDisplayPoint highlightedPoint, boolean isHighlighted, MouseEvent event) Called by the processXXXEvent() method when the highlight state of the given point has changed.
protected String	getInfoText(IlvDisplayPoint pt) Returns the text to be displayed.
protected String	getInfoTextDescriptionPart(IlvDisplayPoint pt) Returns the first part of the text to be displayed.
protected String	getInfoTextValuePart(IlvDisplayPoint pt) Returns the second part of the text to be displayed.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
protected JToolTip	getToolTip() Returns the tooltip used by the InfoView.
void	interactionStarted(IlvChartInteractor inter, MouseEvent event) Called when the given interactor is about to start an interaction on the given event.
boolean	isFollowingMouse() Returns whether the info view follows the mouse moves.
boolean	isHandling(int x, int y) Returns whether the mouse event located at the specified location should be handled by the interactor.
protected IlvDisplayPoint	pickData(IlvChartDataPicker picker) Returns a display point depending on the given data picker and the current picking mode.
void	processMouseMotionEvent(MouseEvent event) Processes a mouse motion event.
void	setFollowingMouse(boolean follow) Sets whether the info view follows the mouse moves.

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

getHighlightedPoint, getHighlightMode, processMouseEvent, processMouseMovedEvent, setHighlightedPoint, setHighlightMode

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

createDataPicker, getPickingMode, 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, 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

Constructor Detail

IlvChartInfoViewInteractor

public IlvChartInfoViewInteractor()

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

IlvChartInfoViewInteractor

public IlvChartInfoViewInteractor(int yAxisIndex)

Creates a new IlvChartInfoViewInteractor object linked to the given Y-axis.

Method Detail

getLocalizedName

public static String getLocalizedName(Locale locale)

Returns a localized name for this interactor class.

Since:

JViews 7.5

isFollowingMouse

public boolean isFollowingMouse()

Returns whether the info view follows the mouse moves.

See Also:

isFollowingMouse()

setFollowingMouse

public void setFollowingMouse(boolean follow)

Sets whether the info view follows the mouse moves. The default value is false.

getToolTip

protected JToolTip getToolTip()

Returns the tooltip used by the InfoView. May return null if the InfoView has not been created yet.

isHandling

public boolean isHandling(int x,
                          int y)

Returns whether the mouse event located at the specified location should be handled by the interactor. Returns true.

Overrides:

isHandling in class IlvChartHighlightInteractor

processMouseMotionEvent

public void processMouseMotionEvent(MouseEvent event)

Processes a mouse motion event.

Overrides:

processMouseMotionEvent in class IlvChartHighlightInteractor

doIt

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

Called by the processXXXEvent() method when the highlight state of the given point has changed. By default, a ChartHighlightInteractorEvent is fired. This method is overridden to show or hide the infoView, depending on the highlight state of the point.

Overrides:

doIt in class IlvChartHighlightInteractor

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

getInfoText

protected String getInfoText(IlvDisplayPoint pt)

Returns the text to be displayed. By default, returns an HTML formatted string containing the name of the dataset associated with the point and its coordinates.

Parameters:

pt - The highlighted point.

See Also:

getInfoTextDescriptionPart(ilog.views.chart.IlvDisplayPoint), getInfoTextValuePart(ilog.views.chart.IlvDisplayPoint)

getInfoTextDescriptionPart

protected String getInfoTextDescriptionPart(IlvDisplayPoint pt)

Returns the first part of the text to be displayed. By default, returns the name of the data set associated with the point.

Parameters:

pt - The highlighted point.

Returns:

A string, or null for omitting this part.

Since:

JViews 7.5

See Also:

getInfoText(ilog.views.chart.IlvDisplayPoint), IlvDataSet.getName(), IlvTreemapChartRenderer.computeInfoTextDescriptionPart(ilog.views.chart.IlvDisplayObjectArea)

getInfoTextValuePart

protected String getInfoTextValuePart(IlvDisplayPoint pt)

Returns the second part of the text to be displayed. By default, returns the coordinates of the point in data space.

Parameters:

pt - The highlighted point.

Returns:

A string, or null for omitting this part.

Since:

JViews 7.5

See Also:

getInfoText(ilog.views.chart.IlvDisplayPoint), IlvChart.formatXValue(double), IlvChart.formatYValue(int, double), IlvTreemapChartRenderer.computeInfoTextValuePart(ilog.views.chart.IlvDisplayObjectArea)

createToolTip

protected JToolTip createToolTip()

Creates a new JToolTip instance. This method is called once when the InfoView is created. You may override this method to instantiate your own JToolTip subclass.

computePosition

protected Point computePosition(Dimension tooltipSize,
                                int x,
                                int y)

Computes the tooltip location. By default, the tooltip is centered horizontally and above the mouse cursor. You can override this method to modify the way the location is computed.

Parameters:

tooltipSize - The tooltip size.

x - The mouse event x coordinate

y - The mouse event y coordinate

Returns:

The tooltip location.

adjustPosition

protected Point adjustPosition(Point point,
                               Dimension size,
                               Rectangle rootBounds)

Adjusts the tooltip location so that it fits into the root component area.

Parameters:

point - The proposed location of the tooltip, relative to the root area.

size - The size of the tooltip, in pixels.

rootBounds - The root component bounds.

Returns:

The final location of the tooltip, relative to the root area.

Since:

JViews 7.5

interactionStarted

public void interactionStarted(IlvChartInteractor inter,
                               MouseEvent event)

Called when the given interactor is about to start an interaction on the given event. The implementation unhighlight the current point.

Overrides:

interactionStarted in class IlvChartInteractor

pickData

protected IlvDisplayPoint pickData(IlvChartDataPicker picker)

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

Overrides:

pickData in class IlvChartDataInteractor

See Also:

IlvChartDataPicker, IlvChartDataInteractor.setPickingMode(int)