Package com.luciad.view.lightspeed.controller.selection

Class TLspSelectMode

java.lang.Object

com.luciad.view.lightspeed.controller.selection.TLspSelectMode

public final class TLspSelectMode
extends Object

This class defines the different ways a user can select objects in a view.

The default TLspSelectControllerModel can deal with the following modes:

• REPLACE
• ADD
• REMOVE
• INVERT
• NO_CHANGE

Creating custom instances

Custom modes can be retrieved using the getInstance method.

When using a custom one, make sure your TLspSelectControllerModel set on the TLspSelectController can handle this mode. On a default TLspSelectControllerModel, this is done by either overriding the applySelection method or replacing the registered ILspSelectionCandidateHandler instances.

Since:

2012.0

Field Summary

Fields

Modifier and Type	Field	Description
static final TLspSelectMode	ADD	Select mode defining that the candidates for the selection should be added to the current selection.
static final TLspSelectMode	INVERT	Select mode defining that the current selection state of the candidates for the selection should be toggled: those that were selected are deselected, those that were deselected are selected.
static final TLspSelectMode	NO_CHANGE	Select mode defining that no changes must be made to the selection.
static final TLspSelectMode	REMOVE	Select mode defining that the candidates for the selection should be removed from the current selection.
static final TLspSelectMode	REPLACE	Select mode defining that the current selection is replaced by a new selection.

Method Summary

Modifier and Type	Method	Description
static TLspSelectMode	getInstance(String aName)	Returns an instance of a TLspSelectMode based on a name.
String	getName()	Returns the name of this select mode.
String	toString()	Returns the name of this select mode.

Methods inherited from class java.lang.Object

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

Field Details

REPLACE

public static final TLspSelectMode REPLACE

Select mode defining that the current selection is replaced by a new selection. This means that, before selection is applied, the existing selection of all layers in the relevant view should be cleared. After that the candidates for selection are selected.

ADD

public static final TLspSelectMode ADD

Select mode defining that the candidates for the selection should be added to the current selection.

REMOVE

public static final TLspSelectMode REMOVE

Select mode defining that the candidates for the selection should be removed from the current selection.

INVERT

public static final TLspSelectMode INVERT

Select mode defining that the current selection state of the candidates for the selection should be toggled: those that were selected are deselected, those that were deselected are selected.

NO_CHANGE

public static final TLspSelectMode NO_CHANGE

Select mode defining that no changes must be made to the selection.

Method Details

getInstance

public static TLspSelectMode getInstance(String aName)

Returns an instance of a TLspSelectMode based on a name.

Parameters:

aName - the name of the TLspSelectMode.

Returns:

the TLspSelectMode.

getName

public String getName()

Returns the name of this select mode.

Returns:

the name.

toString

public String toString()

Returns the name of this select mode.

Overrides:

toString in class Object

Returns:

the name.