ilog.views.chart.interactor

Class IlvChartDataIndicatorInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartDataIndicatorInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

public class IlvChartDataIndicatorInteractor
extends IlvChartInteractor

A class to interact on an IlvDataIndicator. The IlvChartDataIndicatorInteractor class provides the following facilities to graphically modify the definition of a data indicator:

• Drag a border of the indicator to modify the value of the corresponding bound.
• Drag the indicator itself to modify the corresponding range definition.

.

The IlvChartDataIndicatorInteractor defines two modes of interaction whether its opaqueEdit property is enabled or not. If the property is enabled, the indicator modification is "real time": each mouseMotion event immediately modifies the indicator values and hence cannot be canceled. If the mode is disabled, the indicator modification will only be performed when the interaction ends (on a MOUSE_RELEASED event).

The registered name of this interactor is "DataIndicator".

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.IlvChartInteractor

INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors

Constructor and Description
IlvChartDataIndicatorInteractor() Creates a new IlvChartDataIndicatorInteractor object associated to the BUTTON1_MASK mouse button with the opaqueEdit mode disabled.
IlvChartDataIndicatorInteractor(int yAxisIdx, int buttonOrKeyEventMask, boolean opaqueEdit) Creates a new IlvChartEditPointInteractor object associated with the given mouse button linked to the given Y-axis.

Method Summary

Modifier and Type	Method and Description
protected void	abort() Called when the interaction has been aborted.
protected void	drawGhost(Graphics g) Draws the ghost.
protected void	endOperation(MouseEvent event) Called when the interaction ends.
protected Rectangle	getGhostBounds() Returns the ghost bounds.
protected IlvDataIndicator	getIndicator() Returns the indicator that is being dragged.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
boolean	has3DSupport() Indicates whether the interactor can be used with a 3D chart.
boolean	isOpaqueEdit() Returns whether the opaqueEdit mode is enabled.
void	processKeyEvent(KeyEvent event) Handles the key event.
void	processMouseEvent(MouseEvent event) Handles the mouse events.
void	processMouseMotionEvent(MouseEvent event) Handles the mouse motion events.
void	setOpaqueEdit(boolean opaque) Sets whether the opaqueEdit mode is enabled.
protected void	startOperation(MouseEvent event) Called when the interaction starts.
protected void	validate(IlvDoublePoint pt) Called to validate the new position.

Methods inherited from class ilog.views.chart.IlvChartInteractor

addChartInteractionListener, chartConnected, create, create, disableEvents, drawGhost, enableEvents, fireChartInteractionEvent, getAWTEventMask, getChart, getCoordinateSystem, getData, getData, getEventMask, getEventMaskEx, getGhostColor, getInteractorClassByName, getLocalizedName, getPriority, getRegisteredInteractorsByName, getShortName, getXAxis, getXORColor, getYAxis, getYAxisIndex, handleExpose, initGhostGraphics, interactionStarted, isAborted, isAllowDrawGhost, isConsumeEvents, isHandling, isInOperation, isXORGhost, 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

IlvChartDataIndicatorInteractor

public IlvChartDataIndicatorInteractor()

Creates a new IlvChartDataIndicatorInteractor object associated to the BUTTON1_MASK mouse button with the opaqueEdit mode disabled.

IlvChartDataIndicatorInteractor

public IlvChartDataIndicatorInteractor(int yAxisIdx,
                                       int buttonOrKeyEventMask,
                                       boolean opaqueEdit)

Creates a new IlvChartEditPointInteractor object associated with the given mouse button 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

getIndicator

protected final IlvDataIndicator getIndicator()

Returns the indicator that is being dragged.

isOpaqueEdit

public final boolean isOpaqueEdit()

Returns whether the opaqueEdit mode is enabled.

See Also:

setOpaqueEdit(boolean)

setOpaqueEdit

public void setOpaqueEdit(boolean opaque)

Sets whether the opaqueEdit mode is enabled. This property defines how the modifications are propagated to the indicator. If true, each mouse event corresponds to an immediate indicator modification. If false, the modification occurs when the interaction ends. The default value is false.

drawGhost

protected void drawGhost(Graphics g)

Draws the ghost.

Overrides:

drawGhost in class IlvChartInteractor

getGhostBounds

protected Rectangle getGhostBounds()

Returns the ghost bounds.

Overrides:

getGhostBounds in class IlvChartInteractor

validate

protected void validate(IlvDoublePoint pt)

Called to validate the new position. You can override this method to perform additional checks. The default implementation clip the point to the coordinate system data window.

Parameters:

pt - The new position to validate (in data coordinate system).

processMouseEvent

public void processMouseEvent(MouseEvent event)

Handles the mouse events.

Overrides:

processMouseEvent in class IlvChartInteractor

processMouseMotionEvent

public void processMouseMotionEvent(MouseEvent event)

Handles the mouse motion events.

Overrides:

processMouseMotionEvent in class IlvChartInteractor

processKeyEvent

public void processKeyEvent(KeyEvent event)

Handles the key event.

Overrides:

processKeyEvent in class IlvChartInteractor

has3DSupport

public boolean has3DSupport()

Indicates whether the interactor can be used with a 3D chart.

Specified by:

has3DSupport in interface IlvChart3DSupport

Overrides:

has3DSupport in class IlvChartInteractor

Returns:

false.

Since:

JViews 5.5

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