ilog.views.chart.interactor

Class IlvTreemapChartFocusInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataInteractor

ilog.views.chart.interactor.IlvTreemapChartFocusInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

public class IlvTreemapChartFocusInteractor
extends IlvChartDataInteractor

An interactor that provides a kind of "drill down" for a treemap. It allows the user to change the focus of a treemap by clicking on a rectangle in the treemap view. When the user clicks on the "focus parent margin" - a margin at the border of the treemap - the focus is changed to the next enclosing one, that is, to the parent object in the tree.

The registered name of this interactor is "Focus".

Since:

JViews 7.5

See Also:

IlvChartDataInteractor, IlvTreemapChartRenderer.setFocus(javax.swing.tree.TreePath), IlvTreemapChartRenderer.setFocusParentMarginProportion(double), IlvTreemapChartRenderer.setMaximumFocusParentMargin(double), 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
IlvTreemapChartFocusInteractor() Creates a new IlvTreemapChartFocusInteractor associated with a double-click on the mouse button BUTTON1.
IlvTreemapChartFocusInteractor(int pickButtonEventMask, int pickClickCount) Creates a new IlvTreemapChartFocusInteractor associated with the given mouse button and click count.

Method Summary

Modifier and Type	Method and Description
protected void	abort() Called when the interaction has been aborted.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when an interactor has been added to a chart.
protected void	endOperation(MouseEvent event) Called when the interaction ends.
protected void	focusDeleted(IlvChartRenderer renderer, TreePath oldFocus) Called when the focus has been removed from the model.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
protected void	pick(IlvDisplayObjectArea pickedArea) Called when an area has been picked.
void	processKeyEvent(KeyEvent event) Handles the key events.
void	processMouseEvent(MouseEvent event) Handles the mouse events.

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

createDataPicker, getPickingMode, pickData, pickData, setPickingMode

Methods inherited from class ilog.views.chart.IlvChartInteractor

addChartInteractionListener, 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, startOperation, toDisplay

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreemapChartFocusInteractor

public IlvTreemapChartFocusInteractor()

Creates a new IlvTreemapChartFocusInteractor associated with a double-click on the mouse button BUTTON1.

IlvTreemapChartFocusInteractor

public IlvTreemapChartFocusInteractor(int pickButtonEventMask,
                                      int pickClickCount)

Creates a new IlvTreemapChartFocusInteractor associated with the given mouse button and click count.

Parameters:

pickButtonEventMask - An event mask corresponding to a mouse button.

pickClickCount - 1 for single-click, 2 for double-click.

Method Detail

getLocalizedName

public static String getLocalizedName(Locale locale)

Returns a localized name for this interactor class.

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(IlvDisplayObjectArea pickedArea)

Called when an area has been picked. The default implementation calls setFocus on the treemap renderer.

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

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when an interactor has been added to a chart. You should not call this method directly.

Overrides:

chartConnected in class IlvChartInteractor

Parameters:

oldChart - The previous attached chart.

newChart - The new attached chart.

See Also:

IlvChart.addInteractor(ilog.views.chart.IlvChartInteractor)

focusDeleted

protected void focusDeleted(IlvChartRenderer renderer,
                            TreePath oldFocus)

Called when the focus has been removed from the model. If this method does nothing, the view would become empty. For example, this method can:

• Look whether the previously focused node has moved to a different place in the tree model, and set the focus to it. Or
• Look for the nearest enclosing ancestor that is still in the model, and set the focus to it. Or
• Always reset the focus to null, thus re-enabling the view of the entire model.

This default implementation resets the focus to null.