TLcdGXYZoomWheelController (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.view.gxy.controller.ALcdGXYController
- - com.luciad.view.gxy.controller.TLcdGXYZoomWheelController

All Implemented Interfaces:

ILcdUndoableSource, ILcdAWTEventListener, ILcdStatusSource, ILcdGXYChainableController, ILcdGXYController, MouseMotionListener, MouseWheelListener, Serializable, EventListener
```
public class TLcdGXYZoomWheelController
extends ALcdGXYController
implements MouseMotionListener, MouseWheelListener, ILcdUndoableSource, ILcdGXYChainableController
```
Provides scroll wheel zoom support.
When the mouse wheel is scrolled then the scale of the view to which this controller is set is changed exponentially. The direction of the zoom (in or out for forward scrolling) and the zooming factor can be set.

The controller allows setting whether the view should be repainted continuously or not. When the view contains layers which take a long time to paint and which are not painted asynchronously it is not advisable to use continuous painting as the higher number of repaints blocks the GUI for a longer time.

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TLcdGXYZoomWheelController()` Creates a new `TLcdGXYZoomWheelController` that zooms out when scrolling down and zooms in when scrolling up.
`TLcdGXYZoomWheelController(boolean aScrollUpZoomOut, boolean aContinuousRepaint)` Constructs a new `TLcdGXYZoomWheelController`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addUndoableListener(ILcdUndoableListener aListener)` Adds a listener to this source, so this listener is notified when something undoable has happened.
`void`	`appendGXYController(ILcdGXYChainableController aEnd)` This method will append the passed controller to the end of the chain.
`protected void`	`fireUndoableHappened(ILcdUndoable aUndoable)`
`ILcdGXYChainableController`	`getNextGXYController()` Returns a reference to the controller that is located after this one in a chain, or null if this controller is the last element of the chain.
`ILcdGXYScaleLevelProvider`	`getScaleLevelProvider()` Returns the scale level provider used for ctrl-zoom.
`double`	`getZoomFactor()` Returns the factor by which the view will be zoomed in or out for one mouse wheel 'click'.
`void`	`handleAWTEvent(AWTEvent aEvent)` This is method is called when the target of the listener has a new AWTEvent available.
`boolean`	`isEnableSnapToScaleLevels()` Returns if snapping to scale levels is enabled when holding the control key.
`void`	`mouseDragged(MouseEvent aMouseEvent)` Stores the location to zoom in to or to zoom out from.
`void`	`mouseMoved(MouseEvent aMouseEvent)` Stores the location to zoom in to or to zoom out from.
`void`	`mouseWheelMoved(MouseWheelEvent e)` Zooms the map in or out or stores the total mouse wheel activity depending on whether the view should be repainted continuously or not.
`void`	`paint(Graphics aGraphics)` Enables the controller to give visual feedback on the current user interactions.
`void`	`removeUndoableListener(ILcdUndoableListener aListener)` Removes the specified listener so it is no longer notified.
`void`	`setEnableSnapToScaleLevels(boolean aEnableSnapToScaleLevels)` Enables or disables snapping to scale levels when holding the control key.
`void`	`setNextGXYController(ILcdGXYChainableController aNext)` This method sets the next controller in the chain for this controller.
`void`	`setScaleLevelProvider(ILcdGXYScaleLevelProvider aScaleLevelProvider)` Sets the scale level provider used for ctrl-zoom.
`void`	`setZoomFactor(double aZoomFactor)` Sets the factor by which the view will be zoomed in or out for one mouse wheel 'click'.
`void`	`startInteraction(ILcdGXYView aGXYView)` Sets up the controller to receive input through the view passed.
`void`	`terminateInteraction(ILcdGXYView aGXYView)` Releases a few items.

Methods inherited from class com.luciad.view.gxy.controller.ALcdGXYController
addStatusListener, asGXYController, fireStatusEvent, getCursor, getGXYView, getIcon, getName, getShortDescription, isTraceOn, registerInstance, removeStatusListener, retrieveGXYViewXYWorldTransformation, setClassTraceOn, setCursor, setGXYView, setIcon, setName, setShortDescription, setTraceOn, viewRepaint

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

Methods inherited from interface com.luciad.view.gxy.ILcdGXYController
getCursor, getIcon, getLayered, getName, getShortDescription, viewRepaint

- Constructor Detail
  - TLcdGXYZoomWheelController
```
public TLcdGXYZoomWheelController()
```
    Creates a new TLcdGXYZoomWheelController that zooms out when scrolling down and zooms in when scrolling up. It repaints continuously, on every mouse wheel change.
  - TLcdGXYZoomWheelController
```
public TLcdGXYZoomWheelController(boolean aScrollUpZoomOut,
                                  boolean aContinuousRepaint)
```
    Constructs a new TLcdGXYZoomWheelController.
    
    Parameters:
    
    aScrollUpZoomOut - the zoom direction of the scroll wheel. true means when the scroll wheel is pushed away from the user (scroll up), the map 'moves away' (zooms out). If set to false, scrolling up means zooming in.
    
    aContinuousRepaint - true means the map will be zoomed on every mouse wheel change. On false, mouse wheel changes are accumulated and performed only once.
- Method Detail
  - addUndoableListener
```
public void addUndoableListener(ILcdUndoableListener aListener)
```
    Description copied from interface: ILcdUndoableSource
    
    Adds a listener to this source, so this listener is notified when something undoable has happened.
    
    Specified by:
    
    addUndoableListener in interface ILcdUndoableSource
    
    Parameters:
    
    aListener - The listener to be notified when something undoable has happened.
  - removeUndoableListener
```
public void removeUndoableListener(ILcdUndoableListener aListener)
```
    Description copied from interface: ILcdUndoableSource
    
    Removes the specified listener so it is no longer notified.
    
    Specified by:
    
    removeUndoableListener in interface ILcdUndoableSource
    
    Parameters:
    
    aListener - The listener to remove.
  - fireUndoableHappened
```
protected void fireUndoableHappened(ILcdUndoable aUndoable)
```
  - getZoomFactor
```
public double getZoomFactor()
```
    Returns the factor by which the view will be zoomed in or out for one mouse wheel 'click'. The default value is 1.3.
    
    Returns:
    
    the factor by which the view will be zoomed in or out for one mouse wheel 'click'.
    
    See Also:
    
    setZoomFactor(double)
  - setZoomFactor
```
public void setZoomFactor(double aZoomFactor)
```
    Sets the factor by which the view will be zoomed in or out for one mouse wheel 'click'. The default value is 1.3.
    
    Parameters:
    
    aZoomFactor - the factor by which the view will be zoomed in or out for one mouse wheel 'click'.
    
    See Also:
    
    getZoomFactor()
  - setEnableSnapToScaleLevels
```
public void setEnableSnapToScaleLevels(boolean aEnableSnapToScaleLevels)
```
    Enables or disables snapping to scale levels when holding the control key. If enabled, the configured scale level provider will be used to determine the scale to snap to.
    
    Parameters:
    
    aEnableSnapToScaleLevels - true to enable snapping to scale levels.
    
    See Also:
    
    isEnableSnapToScaleLevels(), setScaleLevelProvider(ILcdGXYScaleLevelProvider)
  - isEnableSnapToScaleLevels
```
public boolean isEnableSnapToScaleLevels()
```
    Returns if snapping to scale levels is enabled when holding the control key. By default, snapping to scale levels is enabled.
    
    Returns:
    
    if snapping to scale levels is enabled.
    
    See Also:
    
    setEnableSnapToScaleLevels(boolean)
  - getScaleLevelProvider
```
public ILcdGXYScaleLevelProvider getScaleLevelProvider()
```
    Returns the scale level provider used for ctrl-zoom.
    
    Returns:
    
    the scale level provider used for ctrl-zoom.
    
    See Also:
    
    setScaleLevelProvider(ILcdGXYScaleLevelProvider)
  - setScaleLevelProvider
```
public void setScaleLevelProvider(ILcdGXYScaleLevelProvider aScaleLevelProvider)
```
    Sets the scale level provider used for ctrl-zoom.
    
    The default provider supports raster models containing ILcdRaster or ILcdMultilevelRaster elements.
    
    When an empty array, or null is returned, no zooming will be performed.
    
    Parameters:
    
    aScaleLevelProvider - the scale level provider used for ctrl-zoom.
    
    See Also:
    
    getScaleLevelProvider(), setEnableSnapToScaleLevels(boolean)
  - mouseMoved
```
public void mouseMoved(MouseEvent aMouseEvent)
```
    Stores the location to zoom in to or to zoom out from.
    
    Specified by:
    
    mouseMoved in interface MouseMotionListener
    
    Parameters:
    
    aMouseEvent - contains the location on the map to zoom in to or to zoom out from.
  - mouseDragged
```
public void mouseDragged(MouseEvent aMouseEvent)
```
    Stores the location to zoom in to or to zoom out from.
    
    Specified by:
    
    mouseDragged in interface MouseMotionListener
    
    Parameters:
    
    aMouseEvent - contains the location on the map to zoom in to or to zoom out from.
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
    Zooms the map in or out or stores the total mouse wheel activity depending on whether the view should be repainted continuously or not.
    
    Specified by:
    
    mouseWheelMoved in interface MouseWheelListener
    
    Parameters:
    
    e - contains the mouse wheel clicks. These are only taken into account when none of the modifiers is activated.
  - paint
```
public void paint(Graphics aGraphics)
```
    Description copied from class: ALcdGXYController
    
    Enables the controller to give visual feedback on the current user interactions. Note that the controller is responsible for repainting the view.
    Empty implementation. Redefine this method to render on the Graphics on which the view is rendered.
    
    Specified by:
    
    paint in interface ILcdGXYController
    
    Overrides:
    
    paint in class ALcdGXYController
    
    Parameters:
    
    aGraphics - the Graphics on which the view was rendered.
  - startInteraction
```
public void startInteraction(ILcdGXYView aGXYView)
```
    Description copied from class: ALcdGXYController
    
    Sets up the controller to receive input through the view passed.
    All ILcdGXYView implementations that support interaction call this method when the controller has been made active with setGXYController on the view, so this method shouldn't normally be called directly. Note that most view implementations add the controller as listener if appropriate before calling this method.
    Sets the cursor on the view and sets the view for which this controller is now active. Sends out a status event based on the short description.
    
    Specified by:
    
    startInteraction in interface ILcdGXYController
    
    Overrides:
    
    startInteraction in class ALcdGXYController
    
    Parameters:
    
    aGXYView - the ILcdGXYView this ILcdGXYController will interact with.
    
    See Also:
    
    ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), ILcdGXYController.terminateInteraction(com.luciad.view.gxy.ILcdGXYView)
  - terminateInteraction
```
public void terminateInteraction(ILcdGXYView aGXYView)
```
    Description copied from class: ALcdGXYController
    
    Releases a few items. Can be redefined but this 'super' method should be called too.
    
    Specified by:
    
    terminateInteraction in interface ILcdGXYController
    
    Overrides:
    
    terminateInteraction in class ALcdGXYController
    
    Parameters:
    
    aGXYView - the ILcdGXYView this ILcdGXYController interacted with.
    
    See Also:
    
    ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), ILcdGXYController.startInteraction(com.luciad.view.gxy.ILcdGXYView)
  - getNextGXYController
```
public ILcdGXYChainableController getNextGXYController()
```
    Description copied from interface: ILcdGXYChainableController
    
    Returns a reference to the controller that is located after this one in a chain, or null if this controller is the last element of the chain.
    
    Specified by:
    
    getNextGXYController in interface ILcdGXYChainableController
    
    Returns:
    
    a reference to the next controller.
    
    See Also:
    
    ILcdGXYChainableController.setNextGXYController(ILcdGXYChainableController)
  - setNextGXYController
```
public void setNextGXYController(ILcdGXYChainableController aNext)
```
    Description copied from interface: ILcdGXYChainableController
    
    This method sets the next controller in the chain for this controller. You can set null if you want the chain to end. This method does not start or terminate any interaction. If you need to replace a controller while it's being used you are responsible for properly terminating and starting it yourself.
    
    Specified by:
    
    setNextGXYController in interface ILcdGXYChainableController
    
    Parameters:
    
    aNext - the reference to the controller that will be the next element in the chain
    
    See Also:
    
    ILcdGXYChainableController.getNextGXYController()
  - appendGXYController
```
public void appendGXYController(ILcdGXYChainableController aEnd)
```
    Description copied from interface: ILcdGXYChainableController
    
    This method will append the passed controller to the end of the chain. The controller will be the stored as the next controller in the last element of the current chain.
    
    Specified by:
    
    appendGXYController in interface ILcdGXYChainableController
    
    Parameters:
    
    aEnd - the controller to be appended to the end of the chain.
  - handleAWTEvent
```
public void handleAWTEvent(AWTEvent aEvent)
```
    Description copied from interface: ILcdAWTEventListener
    
    This is method is called when the target of the listener has a new AWTEvent available.
    
    Specified by:
    
    handleAWTEvent in interface ILcdAWTEventListener
    
    Parameters:
    
    aEvent - The event to be handled.

LuciadLightspeedClass TLcdGXYZoomWheelController

Constructor Summary

Method Summary

Methods inherited from class com.luciad.view.gxy.controller.ALcdGXYController

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.view.gxy.ILcdGXYController

Constructor Detail

TLcdGXYZoomWheelController

TLcdGXYZoomWheelController

Method Detail

addUndoableListener

removeUndoableListener

fireUndoableHappened

getZoomFactor

setZoomFactor

setEnableSnapToScaleLevels

isEnableSnapToScaleLevels

getScaleLevelProvider

setScaleLevelProvider

mouseMoved

mouseDragged

mouseWheelMoved

paint

startInteraction

terminateInteraction

getNextGXYController

setNextGXYController

appendGXYController

handleAWTEvent