IlvChartEditPointInteractor (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.chart.IlvChartInteractor
- - ilog.views.chart.interactor.IlvChartDataInteractor
  - - ilog.views.chart.interactor.IlvChartEditPointInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable
```
public class IlvChartEditPointInteractor
extends IlvChartDataInteractor
```
An interactor to modify the points of a data set.
The IlvChartEditPointInteractor defines two modes of interaction whether its opaqueEdit property is enabled or not. If the property is enabled, the data set modification is "real time": each mouseMotion event is immediately translated to a data set modification and hence cannot be canceled. If the mode is disabled, the data set modification will only be performed when the interaction ends (on a MOUSE_RELEASED event). Note that this property is not linked to any ghost concepts.
This interactor is not applicable in treemap views.
The registered name of this interactor is "EditPoint".

Since:

JViews 5.0

See Also:

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
`IlvChartEditPointInteractor()` Creates a new `IlvChartEditPointInteractor` object associated with the `BUTTON1_DOWN_MASK` mouse button with the `opaqueEdit` mode disabled.
`IlvChartEditPointInteractor(int eventMask, boolean opaqueEdit)` Creates a new `IlvChartEditPointInteractor` object associated with the given mouse button with the specified `opaqueEdit` mode.
`IlvChartEditPointInteractor(int yAxisIndex, int eventMask, boolean opaqueEdit)` Creates a new `IlvChartEditPointInteractor` object associated with the given mouse button with the specified `opaqueEdit` mode linked to the given y-axis.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`abort()` Called when the interaction has been aborted.
`protected IlvChartDataPicker`	`createDataPicker(MouseEvent event)` Creates a new `IlvChartDataPicker` object.
`protected void`	`drawGhost(Graphics g)` Draws the ghost.
`protected void`	`endOperation(MouseEvent event)` Called when the interaction ends.
`protected Cursor`	`getCursor()` Returns the cursor used by the interactor.
`IlvDisplayPoint`	`getEditPoint()` Returns the point currently being edited.
`protected Rectangle`	`getGhostBounds()` Returns the ghost bounds.
`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.
`void`	`interactionStarted(IlvChartInteractor inter, MouseEvent event)` Called when the given interactor is about to start an interaction on the given event.
`boolean`	`isHandling(int x, int y)` Returns whether the mouse event that occurred at the specified location should be handled by the interactor.
`boolean`	`isOpaqueEdit()` Returns whether the `opaqueEdit` mode is enabled.
`boolean`	`isXEditAllowed()` Returns whether modification along the x-axis is allowed.
`boolean`	`isYEditAllowed()` Returns whether modification along the y-axis is allowed.
`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`	`processMouseMovedEvent(MouseEvent event)` Handles a mouse motion event with no button pressed.
`void`	`setOpaqueEdit(boolean opaque)` Sets whether the `opaqueEdit` mode is enabled.
`void`	`setXEditAllowed(boolean edit)` Sets whether modification along the x-axis is allowed.
`void`	`setYEditAllowed(boolean edit)` Sets whether modification along the y-axis is allowed.
`protected void`	`startOperation(MouseEvent event)` Called when the interaction starts.
`protected void`	`validate(IlvDoublePoints pt, IlvDisplayPoint dpt)` Called to validate the new position.

Methods inherited from class ilog.views.chart.interactor.IlvChartDataInteractor
getPickingMode, pickData, pickData, setPickingMode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvChartEditPointInteractor
```
public IlvChartEditPointInteractor()
```
    Creates a new IlvChartEditPointInteractor object associated with the BUTTON1_DOWN_MASK mouse button with the opaqueEdit mode disabled.
  - IlvChartEditPointInteractor
```
public IlvChartEditPointInteractor(int eventMask,
                                   boolean opaqueEdit)
```
    Creates a new IlvChartEditPointInteractor object associated with the given mouse button with the specified opaqueEdit mode.
  - IlvChartEditPointInteractor
```
public IlvChartEditPointInteractor(int yAxisIndex,
                                   int eventMask,
                                   boolean opaqueEdit)
```
    Creates a new IlvChartEditPointInteractor object associated with the given mouse button with the specified opaqueEdit mode 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
  - 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 data set. If true, each mouse event corresponds to an immediate data set modification. If false, the modification occurs when the interaction ends. The default value is false.
  - isXEditAllowed
```
public final boolean isXEditAllowed()
```
    Returns whether modification along the x-axis is allowed.
  - setXEditAllowed
```
public void setXEditAllowed(boolean edit)
```
    Sets whether modification along the x-axis is allowed. The default value is false.
  - isYEditAllowed
```
public final boolean isYEditAllowed()
```
    Returns whether modification along the y-axis is allowed.
  - setYEditAllowed
```
public void setYEditAllowed(boolean edit)
```
    Sets whether modification along the y-axis is allowed. The default value is true.
  - getCursor
```
protected Cursor getCursor()
```
    Returns the cursor used by the interactor.
  - 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
  - isHandling
```
public boolean isHandling(int x,
                          int y)
```
    Returns whether the mouse event that occurred at the specified location should be handled by the interactor.
    
    Overrides:
    
    isHandling in class IlvChartInteractor
  - getEditPoint
```
public IlvDisplayPoint getEditPoint()
```
    Returns the point currently being edited. If the interactor is not in the opaque editing mode, the projected coordinates of the returned display point corresponds to the new location of the point.
    
    See Also:
    
    isOpaqueEdit()
  - 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
  - processMouseMovedEvent
```
public void processMouseMovedEvent(MouseEvent event)
```
    Handles a mouse motion event with no button pressed.
    
    Parameters:
    
    event - An event of type MOUSE_MOVED or MOUSE_ENTERED.
    
    Since:
    
    JViews 8.5
  - processKeyEvent
```
public void processKeyEvent(KeyEvent event)
```
    Handles the key event.
    
    Overrides:
    
    processKeyEvent in class IlvChartInteractor
  - validate
```
protected void validate(IlvDoublePoints pt,
                        IlvDisplayPoint dpt)
```
    Called to validate the new position. You can override this method to perform additional checks. The default implementation does nothing.
    
    Parameters:
    
    pt - The new position to validate (in data coordinate system).
    
    dpt - The display point being modified.
  - 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
  - interactionStarted
```
public void interactionStarted(IlvChartInteractor inter,
                               MouseEvent event)
```
    Called when the given interactor is about to start an interaction on the given event.
    
    Overrides:
    
    interactionStarted in class IlvChartInteractor
  - createDataPicker
```
protected IlvChartDataPicker createDataPicker(MouseEvent event)
```
    Creates a new IlvChartDataPicker object.
    The IlvChartEditPointInteractor class uses a data picker that looks for editable data sets.
    
    Overrides:
    
    createDataPicker in class IlvChartDataInteractor
    
    See Also:
    
    IlvDefaultChartDataPicker
  - 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

Class IlvChartEditPointInteractor

Nested Class Summary

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

Field Summary

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

Fields inherited from class ilog.views.chart.IlvChartInteractor

Constructor Summary

Method Summary

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

Methods inherited from class ilog.views.chart.IlvChartInteractor

Methods inherited from class java.lang.Object

Constructor Detail

IlvChartEditPointInteractor

IlvChartEditPointInteractor

IlvChartEditPointInteractor

Method Detail

getLocalizedName

isOpaqueEdit

setOpaqueEdit

isXEditAllowed

setXEditAllowed

isYEditAllowed

setYEditAllowed

getCursor

drawGhost

getGhostBounds

isHandling

getEditPoint

processMouseEvent

processMouseMotionEvent

processMouseMovedEvent

processKeyEvent

validate

has3DSupport

interactionStarted

createDataPicker

startOperation

endOperation

abort