IlvChartZoomInteractor (Rogue Wave JViews 9.2 API)

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

All Implemented Interfaces:

IlvChart3DSupport, Serializable

Direct Known Subclasses:

IlvChartLocalZoomInteractor
```
public class IlvChartZoomInteractor
extends IlvChartInteractor
```
An interactor to zoom a specific chart area.
The registered name of this interactor is "Zoom".

Since:

JViews 5.0

See Also:

IlvChartInteractor, Serialized Form

Field Summary
- Fields inherited from class ilog.views.chart.IlvChartInteractor
  INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors
Constructor and Description
`IlvChartZoomInteractor()` Creates a new `IlvChartZoomInteractor` object with the zoom interaction associated with the BUTTON1 mouse button and the `zoomOut` modifier set on the SHIFT modifier and linked to the first Y-axis.
`IlvChartZoomInteractor(int zoomInEventMask, int zoomOutEventMask)` Creates a new `IlvChartZoomInteractor` object linked to the first y-axis.
`IlvChartZoomInteractor(int yAxisIndex, int zoomInEventMask, int zoomOutEventMask)` Creates a new `IlvChartZoomInteractor` object.

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`	`doIt()` Called when the interaction ends to perform the zoom.
`protected void`	`drawGhost(Graphics g)` Draws the ghost.
`protected void`	`endOperation(MouseEvent event)` Called when the interaction ends.
`int`	`getAnimationStep()` Returns the number of animation step.
`protected IlvDataWindow`	`getDraggedWindow()` Returns the current dragged data window.
`protected Rectangle`	`getGhostBounds()` Returns the ghost bounds.
`static String`	`getLocalizedName(Locale locale)` Returns a localized name for this interactor class.
`protected IlvDataWindow`	`getZoomedDataWindow()` Returns the current zoomed data window.
`protected Cursor`	`getZoomInCursor()` Returns the `zoomIn` mouse cursor.
`int`	`getZoomInEventMask()` Returns the zoom in event mask.
`int`	`getZoomInEventMaskEx()` Returns the zoom in event mask, according to the conventions of `java.awt.event.InputEvent.getModifiersEx()`.
`protected Cursor`	`getZoomOutCursor()` Returns the `zoomOut` mouse cursor.
`int`	`getZoomOutEventMask()` Returns the zoom out event mask.
`int`	`getZoomOutEventMaskEx()` Returns the zoom out event mask, according to the conventions of `java.awt.event.InputEvent.getModifiersEx()`.
`boolean`	`has3DSupport()` Indicates whether the interactor can be used with a 3D chart.
`protected boolean`	`isValid(MouseEvent event)` Returns whether the given event is valid to start the interaction.
`protected boolean`	`isValidStartPoint(double x, double y)` Returns whether the given point is a valid point to handle.
`boolean`	`isXZoomAllowed()` Returns whether zooming along the X-axis is allowed.
`boolean`	`isYZoomAllowed()` Returns whether zooming along the Y-axis is allowed.
`protected boolean`	`isZoomingOut()` Returns whether the interactor is in a `zoomOut` process.
`boolean`	`isZoomOutAllowed()` Returns whether zooming out is allowed.
`void`	`processKeyEvent(KeyEvent event)` Handles the key events.
`void`	`processMouseEvent(MouseEvent event)` Handles the mouse events.
`void`	`processMouseMotionEvent(MouseEvent event)` Handles the mouse motion events.
`void`	`setAnimationStep(int step)` Sets the number of animation step.
`void`	`setXZoomAllowed(boolean allow)` Sets whether zooming along the X-axis is allowed.
`void`	`setYZoomAllowed(boolean allow)` Sets whether zooming along the Y-axis is allowed.
`void`	`setZoomInEventMask(int zoomInEventMask)` Sets the zoom in event mask.
`void`	`setZoomOutAllowed(boolean allow)` Sets whether zooming out is allowed.
`void`	`setZoomOutEventMask(int zoomOutEventMask)` Sets the zoom out event mask.
`protected void`	`startOperation(MouseEvent event)` Called when the interaction starts.
`protected void`	`validate(IlvDataWindow draggedDataWindow)` Called to validate the current dragged `dataWindow`.

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

- Constructor Detail
  - IlvChartZoomInteractor
```
public IlvChartZoomInteractor()
```
    Creates a new IlvChartZoomInteractor object with the zoom interaction associated with the BUTTON1 mouse button and the zoomOut modifier set on the SHIFT modifier and linked to the first Y-axis.
  - IlvChartZoomInteractor
```
public IlvChartZoomInteractor(int zoomInEventMask,
                              int zoomOutEventMask)
```
    Creates a new IlvChartZoomInteractor object linked to the first y-axis.
    
    Parameters:
    
    zoomInEventMask - The event mask used to zoom in.
    
    zoomOutEventMask - The event mask used to zoom out.
  - IlvChartZoomInteractor
```
public IlvChartZoomInteractor(int yAxisIndex,
                              int zoomInEventMask,
                              int zoomOutEventMask)
```
    Creates a new IlvChartZoomInteractor object.
    
    Parameters:
    
    yAxisIndex - The y-axis index.
    
    zoomInEventMask - The event mask used to zoom in.
    
    zoomOutEventMask - The event mask used to zoom out.
- Method Detail
  - getLocalizedName
```
public static String getLocalizedName(Locale locale)
```
    Returns a localized name for this interactor class.
    
    Since:
    
    JViews 7.5
  - getZoomOutEventMask
```
public final int getZoomOutEventMask()
```
    Returns the zoom out event mask.
    
    See Also:
    
    setZoomOutEventMask(int), getZoomOutEventMaskEx()
  - getZoomOutEventMaskEx
```
public final int getZoomOutEventMaskEx()
```
    Returns the zoom out event mask, according to the conventions of java.awt.event.InputEvent.getModifiersEx(). This mask is computed from getZoomOutEventMask().
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getZoomOutEventMask(), setZoomOutEventMask(int)
  - setZoomOutEventMask
```
public void setZoomOutEventMask(int zoomOutEventMask)
```
    Sets the zoom out event mask.
    Note: In the mask, InputEvent.BUTTON2_DOWN_MASK should be used instead of InputEvent.BUTTON2_MASK, and InputEvent.BUTTON3_DOWN_MASK should be used instead of InputEvent.BUTTON3_MASK, because the values of ALT_MASK/BUTTON2_MASK and META_MASK/BUTTON3_MASK overlap.
    
    See Also:
    
    getZoomOutEventMask()
  - getZoomInEventMask
```
public int getZoomInEventMask()
```
    Returns the zoom in event mask.
    
    See Also:
    
    setZoomInEventMask(int), getZoomInEventMaskEx()
  - getZoomInEventMaskEx
```
public int getZoomInEventMaskEx()
```
    Returns the zoom in event mask, according to the conventions of java.awt.event.InputEvent.getModifiersEx(). This mask is computed from getZoomOutEventMask().
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getZoomInEventMask(), setZoomInEventMask(int)
  - setZoomInEventMask
```
public void setZoomInEventMask(int zoomInEventMask)
```
    Sets the zoom in event mask.
    Note: In the mask, InputEvent.BUTTON2_DOWN_MASK should be used instead of InputEvent.BUTTON2_MASK, and InputEvent.BUTTON3_DOWN_MASK should be used instead of InputEvent.BUTTON3_MASK, because the values of ALT_MASK/BUTTON2_MASK and META_MASK/BUTTON3_MASK overlap.
    
    See Also:
    
    getZoomInEventMask()
  - getAnimationStep
```
public final int getAnimationStep()
```
    Returns the number of animation step.
  - setAnimationStep
```
public void setAnimationStep(int step)
```
    Sets the number of animation step. zero disables the animation. The default value is 10.
  - isXZoomAllowed
```
public final boolean isXZoomAllowed()
```
    Returns whether zooming along the X-axis is allowed.
  - setXZoomAllowed
```
public void setXZoomAllowed(boolean allow)
```
    Sets whether zooming along the X-axis is allowed. The default value is true.
  - isYZoomAllowed
```
public final boolean isYZoomAllowed()
```
    Returns whether zooming along the Y-axis is allowed.
  - setYZoomAllowed
```
public void setYZoomAllowed(boolean allow)
```
    Sets whether zooming along the Y-axis is allowed. The default value is false.
  - isZoomOutAllowed
```
public boolean isZoomOutAllowed()
```
    Returns whether zooming out is allowed.
    
    See Also:
    
    setZoomOutAllowed(boolean)
  - setZoomOutAllowed
```
public void setZoomOutAllowed(boolean allow)
```
    Sets whether zooming out is allowed. The default value is true.
  - isZoomingOut
```
protected boolean isZoomingOut()
```
    Returns whether the interactor is in a zoomOut process.
  - getDraggedWindow
```
protected final IlvDataWindow getDraggedWindow()
```
    Returns the current dragged data window.
  - getZoomedDataWindow
```
protected IlvDataWindow getZoomedDataWindow()
```
    Returns the current zoomed data window. This method differs from getDraggedWindow() in the fact that it returns the data window resulting of the current zoom action.
  - getZoomInCursor
```
protected Cursor getZoomInCursor()
```
    Returns the zoomIn mouse cursor.
  - getZoomOutCursor
```
protected Cursor getZoomOutCursor()
```
    Returns the zoomOut mouse cursor.
  - 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
  - isValid
```
protected boolean isValid(MouseEvent event)
```
    Returns whether the given event is valid to start the interaction.
    
    Parameters:
    
    event - A MouseEvent of type MOUSE_PRESSED.
  - 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 events.
    
    Overrides:
    
    processKeyEvent in class IlvChartInteractor
  - isValidStartPoint
```
protected boolean isValidStartPoint(double x,
                                    double y)
```
    Returns whether the given point is a valid point to handle. The default implementation returns true.
  - validate
```
protected void validate(IlvDataWindow draggedDataWindow)
```
    Called to validate the current dragged dataWindow. The default implementation does nothing.
  - doIt
```
protected void doIt()
```
    Called when the interaction ends to perform the zoom. The default implementation computes the new zoom factor according to the zoomed data window.
    
    See Also:
    
    IlvChart.zoom(ilog.views.chart.IlvDataWindow, int)
  - 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 IlvChartZoomInteractor

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

IlvChartZoomInteractor

IlvChartZoomInteractor

IlvChartZoomInteractor

Method Detail

getLocalizedName

getZoomOutEventMask

getZoomOutEventMaskEx

setZoomOutEventMask

getZoomInEventMask

getZoomInEventMaskEx

setZoomInEventMask

getAnimationStep

setAnimationStep

isXZoomAllowed

setXZoomAllowed

isYZoomAllowed

setYZoomAllowed

isZoomOutAllowed

setZoomOutAllowed

isZoomingOut

getDraggedWindow

getZoomedDataWindow

getZoomInCursor

getZoomOutCursor

drawGhost

getGhostBounds

isValid

processMouseEvent

processMouseMotionEvent

processKeyEvent

isValidStartPoint

validate

doIt

has3DSupport

startOperation

endOperation

abort