Package com.luciad.view.gxy.controller

Class TLcdGXYNavigateController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.TLcdGXYNavigateController

All Implemented Interfaces:

ILcdAWTEventListener, ILcdStatusSource, ILcdGXYChainableController, ILcdGXYController, Serializable

public final class TLcdGXYNavigateController
extends ALcdGXYController
implements ILcdGXYChainableController

Mouse controller to navigate on a GXY map. It supports:

• Panning by dragging the mouse
• Zooming by using the mouse wheel

It can be appended to any chainable controller to add navigation behavior:

  controller.appendGXYController(new TLcdGXYNavigateController());
 

Since:

2019.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TLcdGXYNavigateController()	Default constructor for the controller.

Method Summary

Modifier and Type	Method	Description
void	appendGXYController(ILcdGXYChainableController aEnd)	This method will append the passed controller to the end of the chain.
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.
void	handleAWTEvent(AWTEvent aEvent)	This is method is called when the target of the listener has a new AWTEvent available.
void	paint(Graphics aGraphics)	Enables the controller to give visual feedback on the current user interactions.
void	setNextGXYController(ILcdGXYChainableController aNext)	This method sets the next controller in the chain for this controller.
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 Details

TLcdGXYNavigateController

public TLcdGXYNavigateController()

Default constructor for the controller.

Method Details

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)

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.

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.

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)