com.luciad.view.gxy.controller

LuciadFusionClass TLcdGXYSelectController

java.lang.Object

com.luciad.view.gxy.controller.ALcdGXYController

com.luciad.view.gxy.controller.ALcdGXYSmartController

com.luciad.view.gxy.controller.TLcdGXYDragRectangleController

com.luciad.view.gxy.controller.TLcdGXYSelectController

All Implemented Interfaces:

ILcdUndoableSource, ILcdStatusSource, ILcdGXYController, KeyListener, MouseListener, MouseMotionListener, Serializable, EventListener

Direct Known Subclasses:

TLcdGXYEditController

Deprecated.

as of version 10.0. It is advised to use the more flexible and powerful TLcdGXYSelectController2 instead. The functionality of this class will remain present as is.

public class TLcdGXYSelectController
extends TLcdGXYDragRectangleController
implements MouseListener

The TLcdGXYSelectController can be used for selecting Objects in an ILcdGXYView, and put them in the selection of their respective ILcdGXYLayer. The selection can be performed by clicking or dragging a rectangle on the ILcdGXYView.

An ILcdAction to be triggered on a right mouse button pressed can be set using setActionOnRightMouseButtonPressed if the selection mode is equal to ILcdGXYSelectControllerModel.FIRST_TOUCHED.

An ILcdAction to be triggered on a double click can be set using setActionOnDoubleClick.

New selection can be retrieved ILcdGXYLayer by ILcdGXYLayer (see ILcdGXYLayer.selectedObjects)

The way selection is performed can be changing the GXYSelectControllerModel property (see setGXYSelectControllerModel, selectionMode(MouseEvent) ).

Note: For new code, it is advised to use TLcdGXYSelectController2.

See Also:

TLcdGXYSelectController2, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Rectangle	fAWTWorkBounds Deprecated.
protected Rectangle	fLastSelectionClip Deprecated.
protected TLcdGXYLayerSubsetList	fSelection Deprecated.
protected TLcdGXYContext	fWorkContext Deprecated.
protected TLcdXYBounds	fXYWorkBounds Deprecated.

Fields inherited from class com.luciad.view.gxy.controller.TLcdGXYDragRectangleController

fXPressed, fXReleased, fYPressed, fYReleased

Constructor Summary

Constructors

Constructor and Description
TLcdGXYSelectController() Deprecated. Constructs a ILcdGXYController which enables selecting objects in the view using the mouse.
TLcdGXYSelectController(boolean aRegisterInstance) Deprecated. use the constructor without parameters.

Method Summary

Modifier and Type	Method and Description
protected void	addInSelection(Object aObject, ILcdGXYPainter aGXYPainter, ILcdGXYContext aGXYContext) Deprecated. This method is called in the selection process to add aObject in the selection.
protected void	deselectAll(boolean updateView) Deprecated. Deselects all Objects previously selected.
protected void	fireAllLayerCollectedSelectionChanges() Deprecated.
ActionListener	getActionOnDoubleClick() Deprecated. Gets the ActionListener to be triggered on a mouse double click.
ActionListener	getActionOnRightMouseButtonPressed() Deprecated. Gets the ActionListener to be triggered on a right mouse button pressed.
ILcdGXYSelectControllerModel	getGXYSelectControllerModel() Deprecated.
MouseEvent	getLastMousePressedEvent() Deprecated. Retrieves the last MouseEvent received on a mousePressed.
MouseEvent	getLastMouseReleasedEvent() Deprecated. Retrieves the last MouseEvent received on a mouseReleased.
int	getMousePressedSensitivity() Deprecated. Returns the dimension of the square around the mouse pointer taken into account when selecting using a mouse click.
Rectangle	getPreviousSelectionClip() Deprecated.
Rectangle	getSelectionClip() Deprecated.
protected int	getSelectionCount() Deprecated. Counts the number of Objects currently selected.
int	getSensitivity() Deprecated. This method returns the sensitivity that will be used when selecting objects or labels.
protected boolean	isActionOnRightMouseButtonPerformed() Deprecated. Tells if the ILcdAction to be triggered on a right mouse button pressed has been performed or not.
boolean	isInvertSelectionOnAlternateModeDrag() Deprecated. Indicates whether objects that were selected and are selected again dragging a rectangle in ALTERNATE mode should be removed from the selection.
boolean	isSelectInBoundsAllowed() Deprecated.
boolean	isStrictInteraction() Deprecated. Returns whether interaction with the select clip should be strict.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
ILcdGXYLayerSubsetList	lastSelected() Deprecated.
void	mouseDragged(MouseEvent me) Deprecated.
void	mousePressed(MouseEvent me) Deprecated.
void	mouseReleased(MouseEvent me) Deprecated. Implements mouseReleased.
protected void	processRightMouseButtonPressed(MouseEvent e) Deprecated. Processes a right mouse pressed.
protected void	removeFromSelection(Object aObject, ILcdGXYPainter aGXYPainter, ILcdGXYContext aGXYContext) Deprecated. This method is called in the selection process to remove aObject from the selection.
void	selectAt(MouseEvent aMouseEvent, int aSelectionMode) Deprecated. This method performs a selection update when the mouse hit at (x,y) in a ILcdGXYView.
void	selectInBounds(Rectangle aRectangle) Deprecated.
ILcdGXYLayerSubsetList	selection() Deprecated.
protected boolean	selectOnLayer(ILcdGXYContext aGXYContext, int aSelectionMode) Deprecated. Processes a selection update on an ILcdGXYLayer (aGXYContext.getGXYLayer()) at the AWT location [ aGXYContext.getX(), aGXYContext.getY() ], taking into aSelectionMode.
void	setActionOnDoubleClick(ActionListener aActionOnDoubleClick) Deprecated. Sets an ActionListener to be triggered on a mouse double click.
void	setActionOnRightMouseButtonPressed(ActionListener aActionOnRightMouseButtonPressed) Deprecated. Sets an ActionListener to be triggered on a right mouse button pressed.
void	setGXYSelectControllerModel(ILcdGXYSelectControllerModel aGXYSelectControllerModel) Deprecated. Customizes how this TLcdGXYSelectController performs the selection on a ILcdGXYView.
void	setInvertSelectionOnAlternateModeDrag(boolean aInvertSelectionOnAlternateModeDrag) Deprecated. Sets whether currently selected objects should be removed from the selection when they are selected again in the current operation dragging a rectangle in ALTERNATE mode.
void	setMousePressedSensitivity(int aMousePressedSensitivity) Deprecated. Sets the size in pixels of (one side of) the square around the mouse that is taken into account for selection when clicking the mouse.
void	setSelectInBoundsAllowed(boolean aSelectInBoundsAllowed) Deprecated. Sets if selection can be performed by dragging a Rectangle on the ILcdGXYView.
void	setSensitivity(int aSensitivity) Deprecated. This method sets the sensitivity that should be used by painters to determine which object is selected by the input device (usually the mouse).
void	setStrictInteraction(boolean aStrictInteraction) Deprecated. Sets whether interaction with the select clip should be strict.
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	startInteraction(ILcdGXYView aGXYView) Deprecated. Implements ILcdGXYController.startInteraction.
void	terminateInteraction(ILcdGXYView aGXYView) Deprecated. Implements ILcdGXYController.terminateInteraction.
void	undo() Deprecated.

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

adaptRectangle, doPanGXYView, doZoomGXYView, drawGhost, getCurrentRectangle, getGhostColor, getGhostLineWidth, getHaloColor, getHaloThickness, getMouseDraggedSensitivity, getXORModelColor, isDragCentered, isForceToSquare, isHaloEnabled, isRepaintOnReleased, isXORMode, lastXPressed, lastXReleased, lastYPressed, lastYReleased, mouseMoved, paint, setDragCentered, setForceToSquare, setGhostColor, setGhostLineWidth, setHaloColor, setHaloEnabled, setHaloThickness, setMouseDraggedSensitivity, setRepaintOnReleased, setXORMode, setXORModeColor, trigger

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

addUndoableListener, fireUndoableEvent, getDownPanChars, getDownPanCodes, getLeftPanChars, getLeftPanCodes, getPanAbsDelta, getPanAbsDelta, getRightPanChars, getRightPanCodes, getUndoableListenerCount, getUpPanChars, getUpPanCodes, getZoomInChars, getZoomInCodes, getZoomOutChars, getZoomOutCodes, isDragging, isPanOnMouseDragExit, isPanOnMouseMoveExit, isPanUndoable, isRequestFocusOnMouseEntered, isRequestFocusOnMousePressed, isZoomUndoable, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, removeUndoableListener, setDownPanChars, setDownPanCodes, setIsDragging, setLeftPanChars, setLeftPanCodes, setPanAbsDelta, setPanOnMouseDragExit, setPanOnMouseMoveExit, setPanUndoable, setRequestFocusOnMouseEntered, setRequestFocusOnMousePressed, setRightPanChars, setRightPanCodes, setUpPanChars, setUpPanCodes, setZoomInChars, setZoomInCodes, setZoomOutChars, setZoomOutCodes, setZoomUndoable, updateViewLocationAfterZoomSFCT

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

addStatusListener, asGXYController, fireStatusEvent, getCursor, getGXYView, getIcon, getName, getShortDescription, registerInstance, removeStatusListener, retrieveGXYViewXYWorldTransformation, setClassTraceOn, setCursor, setGXYView, setIcon, setName, setShortDescription, viewRepaint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited

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

getLayered

Field Detail

fWorkContext

protected TLcdGXYContext fWorkContext

Deprecated.

fLastSelectionClip

protected Rectangle fLastSelectionClip

Deprecated.

fSelection

protected TLcdGXYLayerSubsetList fSelection

Deprecated.

fAWTWorkBounds

protected Rectangle fAWTWorkBounds

Deprecated.

fXYWorkBounds

protected TLcdXYBounds fXYWorkBounds

Deprecated.

Constructor Detail

TLcdGXYSelectController

public TLcdGXYSelectController()

Deprecated.

Constructs a ILcdGXYController which enables selecting objects in the view using the mouse.

TLcdGXYSelectController

public TLcdGXYSelectController(boolean aRegisterInstance)

Deprecated. use the constructor without parameters.

Method Detail

setTraceOn

public void setTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.

Overrides:

setTraceOn in class TLcdGXYDragRectangleController

Parameters:

aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

isTraceOn

public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Overrides:

isTraceOn in class TLcdGXYDragRectangleController

Returns:

true if tracing is enabled for this class, false otherwise.

selection

public ILcdGXYLayerSubsetList selection()

Deprecated.

Returns:

all the Object currently selected

See Also:

TLcdGXYLayerSubsetList

getLastMousePressedEvent

public MouseEvent getLastMousePressedEvent()

Deprecated.

Retrieves the last MouseEvent received on a mousePressed.

getLastMouseReleasedEvent

public MouseEvent getLastMouseReleasedEvent()

Deprecated.

Retrieves the last MouseEvent received on a mouseReleased.

lastSelected

public ILcdGXYLayerSubsetList lastSelected()

Deprecated.

Returns:

only the Object that have been selected during the last mouse interaction. It is a subset of selection().

See Also:

selection(), TLcdGXYLayerSubsetList

setActionOnRightMouseButtonPressed

public void setActionOnRightMouseButtonPressed(ActionListener aActionOnRightMouseButtonPressed)

Deprecated.

Sets an ActionListener to be triggered on a right mouse button pressed. null means no ActionListener to trigger.

getActionOnRightMouseButtonPressed

public ActionListener getActionOnRightMouseButtonPressed()

Deprecated.

Gets the ActionListener to be triggered on a right mouse button pressed. null means no ActionListener to trigger.

isStrictInteraction

public boolean isStrictInteraction()

Deprecated.

Returns whether interaction with the select clip should be strict.

Returns:

whether interaction with the select clip should be strict. Default value is false.

See Also:

setStrictInteraction(boolean)

setStrictInteraction

public void setStrictInteraction(boolean aStrictInteraction)

Deprecated.

Sets whether interaction with the select clip should be strict.

Parameters:

aStrictInteraction - if true, selection shall be applied only to the Objects interacting with the given clip. If false it can be applied to the same Objects plus others. In general, the retrieval of the Object interacting with the given clip will be faster when aStrictInteraction=false.

See Also:

isStrictInteraction()

getSensitivity

public int getSensitivity()

Deprecated.

This method returns the sensitivity that will be used when selecting objects or labels. It indicates how far (in screen coordinates) the input location (mouse cursor, etc...) can be from the visual representation of an object on the screen and still interact with it. This value will be passed to all created instances of TLcdGXYContext passed to the painters.

Returns:

the sensitivity to be used for selecting objects.

See Also:

setSensitivity(int), TLcdGXYContext.getSensitivity()

setSensitivity

public void setSensitivity(int aSensitivity)

Deprecated.

This method sets the sensitivity that should be used by painters to determine which object is selected by the input device (usually the mouse).

Parameters:

aSensitivity - the sensitivity that will be used for selecting objects.

See Also:

getSensitivity()

setActionOnDoubleClick

public void setActionOnDoubleClick(ActionListener aActionOnDoubleClick)

Deprecated.

Sets an ActionListener to be triggered on a mouse double click. null means no ActionListener to trigger.

getActionOnDoubleClick

public ActionListener getActionOnDoubleClick()

Deprecated.

Gets the ActionListener to be triggered on a mouse double click. null means no ActionListener to trigger.

setSelectInBoundsAllowed

public void setSelectInBoundsAllowed(boolean aSelectInBoundsAllowed)

Deprecated.

Sets if selection can be performed by dragging a Rectangle on the ILcdGXYView.

isInvertSelectionOnAlternateModeDrag

public boolean isInvertSelectionOnAlternateModeDrag()

Deprecated.

Indicates whether objects that were selected and are selected again dragging a rectangle in ALTERNATE mode should be removed from the selection. Default value is false for backwards compatibility, i.e. dragging a rectangle on top of selected objects will not influence the selected objects. Note that this only applies for selection with a rectangle, not for selection with a click.

Returns:

whether objects that were selected and are selected again dragging a rectangle in ALTERNATE mode should be removed from the selection.

See Also:

setInvertSelectionOnAlternateModeDrag(boolean)

setInvertSelectionOnAlternateModeDrag

public void setInvertSelectionOnAlternateModeDrag(boolean aInvertSelectionOnAlternateModeDrag)

Deprecated.

Sets whether currently selected objects should be removed from the selection when they are selected again in the current operation dragging a rectangle in ALTERNATE mode.

Parameters:

aInvertSelectionOnAlternateModeDrag - true to have a more consistent behavior, as consecutive clicks also remove objects from the selection.

See Also:

isInvertSelectionOnAlternateModeDrag()

isSelectInBoundsAllowed

public boolean isSelectInBoundsAllowed()

Deprecated.

See Also:

setSelectInBoundsAllowed(boolean)

isActionOnRightMouseButtonPerformed

protected boolean isActionOnRightMouseButtonPerformed()

Deprecated.

Tells if the ILcdAction to be triggered on a right mouse button pressed has been performed or not.

setGXYSelectControllerModel

public void setGXYSelectControllerModel(ILcdGXYSelectControllerModel aGXYSelectControllerModel)

Deprecated.

Customizes how this TLcdGXYSelectController performs the selection on a ILcdGXYView.

Parameters:

aGXYSelectControllerModel - the ILcdGXYSelectControllerModel to set. null is a valid argument.

See Also:

ILcdGXYSelectControllerModel

getGXYSelectControllerModel

public ILcdGXYSelectControllerModel getGXYSelectControllerModel()

Deprecated.

See Also:

setGXYSelectControllerModel(ILcdGXYSelectControllerModel)

setMousePressedSensitivity

public void setMousePressedSensitivity(int aMousePressedSensitivity)

Deprecated.

Sets the size in pixels of (one side of) the square around the mouse that is taken into account for selection when clicking the mouse.

Parameters:

aMousePressedSensitivity - the size of (one side of) the square that is taken into account for selection when clicking the mouse.

See Also:

getMousePressedSensitivity()

getMousePressedSensitivity

public int getMousePressedSensitivity()

Deprecated.

Returns the dimension of the square around the mouse pointer taken into account when selecting using a mouse click.

See Also:

setMousePressedSensitivity(int)

startInteraction

public void startInteraction(ILcdGXYView aGXYView)

Deprecated.

Implements ILcdGXYController.startInteraction.

Specified by:

startInteraction in interface ILcdGXYController

Overrides:

startInteraction in class ALcdGXYSmartController

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)

Deprecated.

Implements ILcdGXYController.terminateInteraction. Its restores the original painting mode of aGXYView.

Specified by:

terminateInteraction in interface ILcdGXYController

Overrides:

terminateInteraction in class ALcdGXYSmartController

Parameters:

aGXYView - the ILcdGXYView this ILcdGXYController interacted with.

See Also:

ILcdGXYView.setGXYController(com.luciad.view.gxy.ILcdGXYController), ILcdGXYController.startInteraction(com.luciad.view.gxy.ILcdGXYView)

getSelectionClip

public Rectangle getSelectionClip()

Deprecated.

Returns:

the clip of the current selection

getPreviousSelectionClip

public Rectangle getPreviousSelectionClip()

Deprecated.

Returns:

the clip of the previous selection

getSelectionCount

protected int getSelectionCount()

Deprecated.

Counts the number of Objects currently selected.

mouseDragged

public void mouseDragged(MouseEvent me)

Deprecated.

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class TLcdGXYDragRectangleController

mousePressed

public void mousePressed(MouseEvent me)

Deprecated.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class TLcdGXYDragRectangleController

processRightMouseButtonPressed

protected void processRightMouseButtonPressed(MouseEvent e)

Deprecated.

Processes a right mouse pressed. This implementation triggers the ILcdAction set with setActionOnRightMouseButtonPressed, if such ILcdAction has been set. It creates an ActionEvent with "RightMouseButtonPressed" as command field. This method can be redefined.

mouseReleased

public void mouseReleased(MouseEvent me)

Deprecated.

Implements mouseReleased. This method can be redefined to implement a behavior after processing a new selection. Do not forget to start this redefinition by calling super.mouseReleased(me).

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class TLcdGXYDragRectangleController

deselectAll

protected void deselectAll(boolean updateView)

Deprecated.

Deselects all Objects previously selected.

addInSelection

protected void addInSelection(Object aObject,
                              ILcdGXYPainter aGXYPainter,
                              ILcdGXYContext aGXYContext)

Deprecated.

This method is called in the selection process to add aObject in the selection.

Parameters:

aObject - the Object to add in the selection

aGXYPainter - the ILcdGXYPainter used to test that aObject has been touched.

aGXYContext - the ILcdGXYContext used to perform the test

removeFromSelection

protected void removeFromSelection(Object aObject,
                                   ILcdGXYPainter aGXYPainter,
                                   ILcdGXYContext aGXYContext)

Deprecated.

This method is called in the selection process to remove aObject from the selection.

Parameters:

aObject - the Object to add in the selection

aGXYPainter - a valid ILcdGXYPainter for aObject

aGXYContext - a valid ILcdGXYContext to use the ILcdGXYPainter

selectAt

public void selectAt(MouseEvent aMouseEvent,
                     int aSelectionMode)

Deprecated.

This method performs a selection update when the mouse hit at (x,y) in a ILcdGXYView.

Parameters:

aSelectionMode - one of TLcdGXYSelectController.FIRST_TOUCHED, TLcdGXYSelectController.ALTERNATE. On a mousePressed(MouseEvent me), aSelectionMode is the one returned by selectionMode(me).

selectOnLayer

protected boolean selectOnLayer(ILcdGXYContext aGXYContext,
                                int aSelectionMode)

Deprecated.

Processes a selection update on an ILcdGXYLayer (aGXYContext.getGXYLayer()) at the AWT location [ aGXYContext.getX(), aGXYContext.getY() ], taking into aSelectionMode.

Parameters:

aSelectionMode - one of TLcdGXYSelectController.FIRST_TOUCHED, TLcdGXYSelectController.ALTERNATE. On a mousePressed(MouseEvent me), aSelectionMode is the one returned by selectionMode(me)

selectInBounds

public void selectInBounds(Rectangle aRectangle)

Deprecated.

fireAllLayerCollectedSelectionChanges

protected void fireAllLayerCollectedSelectionChanges()

Deprecated.

undo

public void undo()

Deprecated.

Overrides:

undo in class TLcdGXYDragRectangleController