Package com.luciad.view.gxy.controller

Class ALcdGXYChainableController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.ALcdGXYChainableController

All Implemented Interfaces:

ILcdAWTEventListener, ILcdStatusSource, ILcdGXYChainableController, ILcdGXYController, Serializable

Direct Known Subclasses:

ALcdGXYTouchChainableController, TLcdGXYTouchNavigateController, TLcdGXYTouchNewController, TLcdGXYTouchSelectEditController, TLcdMapTouchRulerController

public abstract class ALcdGXYChainableController
extends ALcdGXYController
implements ILcdGXYChainableController

ILcdGXYChainableController that implements startInteraction, terminateInteraction and paint to call a corresponding implementation ( see startInteractionImpl(com.luciad.view.gxy.ILcdGXYView), terminateInteractionImpl(com.luciad.view.gxy.ILcdGXYView) and paintImpl(java.awt.Graphics) ) and then call the same method in the next controller.

ILcdAWTEventListener.handleAWTEvent(java.awt.AWTEvent) should be handled in a similar way, but this is left to the implementations.

Since:

10.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ALcdGXYChainableController()

Method Summary

Modifier and Type	Method	Description
void	addStatusListener(ILcdStatusListener aStatusListener)	Registers the given listener so it will receive status events from this source.
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	paint(Graphics aGraphics)	Enables the controller to give visual feedback on the current user interactions.
protected void	paintImpl(Graphics aGraphics)	The specific implementation of paint for this controller.
void	removeStatusListener(ILcdStatusListener aStatusListener)	Removes the specified listener so it is no longer notified.
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.
protected void	startInteractionImpl(ILcdGXYView aGXYView)	The specific implementation of startInteraction for this controller.
void	terminateInteraction(ILcdGXYView aGXYView)	Releases a few items.
protected void	terminateInteractionImpl(ILcdGXYView aGXYView)	The specific implementation of terminateInteraction for this controller.

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

asGXYController, fireStatusEvent, getCursor, getGXYView, getIcon, getName, getShortDescription, isTraceOn, registerInstance, 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.input.ILcdAWTEventListener

handleAWTEvent

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

getCursor, getIcon, getLayered, getName, getShortDescription, viewRepaint

Constructor Details

ALcdGXYChainableController

public ALcdGXYChainableController()

Method Details

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.

addStatusListener

public void addStatusListener(ILcdStatusListener aStatusListener)

Description copied from interface: ILcdStatusSource

Registers the given listener so it will receive status events from this source.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this status source, you can use a ALcdWeakStatusListener instance as status listener.

Specified by:

addStatusListener in interface ILcdStatusSource

Overrides:

addStatusListener in class ALcdGXYController

Parameters:

aStatusListener - The listener to be notified when the status has changed.

removeStatusListener

public void removeStatusListener(ILcdStatusListener aStatusListener)

Description copied from interface: ILcdStatusSource

Removes the specified listener so it is no longer notified.

Specified by:

removeStatusListener in interface ILcdStatusSource

Overrides:

removeStatusListener in class ALcdGXYController

Parameters:

aStatusListener - The listener to remove.

startInteraction

public void startInteraction(ILcdGXYView aGXYView)

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.

This method also calls startInteraction(com.luciad.view.gxy.ILcdGXYView) on the next controller. Override startInteractionImpl(com.luciad.view.gxy.ILcdGXYView) if you want to add your own behavior to this controller.

Specified by:

startInteraction in interface ILcdGXYController

Overrides:

startInteraction in class ALcdGXYController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController will interact with.

See Also:

• startInteractionImpl(com.luciad.view.gxy.ILcdGXYView)

terminateInteraction

public void terminateInteraction(ILcdGXYView aGXYView)

Releases a few items. Can be redefined but this 'super' method should be called too.

This method also calls terminateInteraction(com.luciad.view.gxy.ILcdGXYView) on the next controller. Override terminateInteractionImpl(com.luciad.view.gxy.ILcdGXYView) if you want to add your own behavior to this controller.

Specified by:

terminateInteraction in interface ILcdGXYController

Overrides:

terminateInteraction in class ALcdGXYController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController interacted with.

See Also:

• terminateInteractionImpl(com.luciad.view.gxy.ILcdGXYView)

paint

public void paint(Graphics aGraphics)

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.

This method also calls paint(java.awt.Graphics) on the next controller. Override paintImpl(java.awt.Graphics) if you want to add your own behavior to this controller.

Specified by:

paint in interface ILcdGXYController

Overrides:

paint in class ALcdGXYController

Parameters:

aGraphics - the Graphics on which the view was rendered.

See Also:

• paintImpl(java.awt.Graphics)

startInteractionImpl

protected void startInteractionImpl(ILcdGXYView aGXYView)

The specific implementation of startInteraction for this controller.

Parameters:

aGXYView - the view to start interaction with.

terminateInteractionImpl

protected void terminateInteractionImpl(ILcdGXYView aGXYView)

The specific implementation of terminateInteraction for this controller.

Parameters:

aGXYView - the view to terminate interaction with.

paintImpl

protected void paintImpl(Graphics aGraphics)

The specific implementation of paint for this controller.

Parameters:

aGraphics - the graphics to be used for painting.