IlvChartPanInteractor (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvChartInteractor
- - ilog.views.chart.interactor.IlvChartPanInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvChartLocalPanInteractor
```
public class IlvChartPanInteractor
extends IlvChartInteractor
```
An interactor to pan the chart area.
The registered name of this interactor is "Pan".

Since:

JViews 5.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
`IlvChartPanInteractor()` Creates a new `IlvChartPanInteractor` object associated with the `BUTTON3 InputEvent` mask and linked to the first Y-axis.
`IlvChartPanInteractor(int buttonMask)` Creates a new `IlvChartPanInteractor` object associated with the given mouse button mask and linked to the first Y-axis.
`IlvChartPanInteractor(int yAxisIndex, int buttonMask)` Creates a new `IlvChartPanInteractor` object associated with the given mouse button event mask and 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 void`	`endOperation(MouseEvent event)` Called when the interaction ends.
`protected Cursor`	`getCursor()` Returns the cursor associated with this interactor.
`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.
`protected boolean`	`isValidStartPoint(double x, double y)` Returns whether the given point (in data coordinate) is valid.
`boolean`	`isXPanAllowed()` Returns whether panning along the X-axis is allowed.
`boolean`	`isYPanAllowed()` Returns whether panning along the Y-axis is allowed.
`protected void`	`pan(IlvDoublePoints oldPos, IlvDoublePoints newPos)` Called by the `processMouseMotionEvent` method to pan the chart.
`void`	`processMouseEvent(MouseEvent event)` Handles the mouse events.
`void`	`processMouseMotionEvent(MouseEvent event)` Handles the mouse motion events.
`void`	`setXPanAllowed(boolean xpan)` Sets whether panning along the X-axis is allowed.
`void`	`setYPanAllowed(boolean ypan)` Sets whether panning along the Y-axis is allowed.
`protected void`	`startOperation(MouseEvent event)` Called when the interaction starts.

Methods inherited from class ilog.views.chart.IlvChartInteractor
addChartInteractionListener, chartConnected, 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, initGhostGraphics, interactionStarted, isAborted, isAllowDrawGhost, isConsumeEvents, isHandling, isInOperation, isXORGhost, processKeyEvent, 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
  - IlvChartPanInteractor
```
public IlvChartPanInteractor()
```
    Creates a new IlvChartPanInteractor object associated with the BUTTON3 InputEvent mask and linked to the first Y-axis.
  - IlvChartPanInteractor
```
public IlvChartPanInteractor(int buttonMask)
```
    Creates a new IlvChartPanInteractor object associated with the given mouse button mask and linked to the first Y-axis.
  - IlvChartPanInteractor
```
public IlvChartPanInteractor(int yAxisIndex,
                             int buttonMask)
```
    Creates a new IlvChartPanInteractor object associated with the given mouse button event mask and 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
  - isXPanAllowed
```
public boolean isXPanAllowed()
```
    Returns whether panning along the X-axis is allowed.
    
    See Also:
    
    setXPanAllowed(boolean)
  - setXPanAllowed
```
public void setXPanAllowed(boolean xpan)
```
    Sets whether panning along the X-axis is allowed. The default value is true.
  - isYPanAllowed
```
public boolean isYPanAllowed()
```
    Returns whether panning along the Y-axis is allowed.
    
    See Also:
    
    setYPanAllowed(boolean)
  - setYPanAllowed
```
public void setYPanAllowed(boolean ypan)
```
    Sets whether panning along the Y-axis is allowed. The default value is false.
  - getCursor
```
protected Cursor getCursor()
```
    Returns the cursor associated with this interactor. By default, it returns the MOVE_CURSOR predefined mouse cursor.
  - 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
  - isValidStartPoint
```
protected boolean isValidStartPoint(double x,
                                    double y)
```
    Returns whether the given point (in data coordinate) is valid. Called when the interaction is about to start. By default it returns true.
  - pan
```
protected void pan(IlvDoublePoints oldPos,
                   IlvDoublePoints newPos)
```
    Called by the processMouseMotionEvent method to pan the chart. By default it computes the delta and calls IlvChart.scroll().
    
    Parameters:
    
    oldPos - The old position of the mouse cursor in data coordinates.
    
    newPos - The new position of the mouse cursor in data coordinates.
  - 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

Class IlvChartPanInteractor

Field Summary

Fields inherited from class ilog.views.chart.IlvChartInteractor

Constructor Summary

Method Summary

Methods inherited from class ilog.views.chart.IlvChartInteractor

Methods inherited from class java.lang.Object

Constructor Detail

IlvChartPanInteractor

IlvChartPanInteractor

IlvChartPanInteractor

Method Detail

getLocalizedName

isXPanAllowed

setXPanAllowed

isYPanAllowed

setYPanAllowed

getCursor

processMouseEvent

processMouseMotionEvent

isValidStartPoint

pan

has3DSupport

startOperation

endOperation

abort