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

Class TLspSelectChoice

java.lang.Object

com.luciad.view.lightspeed.controller.selection.TLspSelectChoice

public final class TLspSelectChoice
extends Object

Determines how to select from a list of (typically overlapping or very close) domain objects. Default available strategies are:

• selecting the topmost visible object
• let the user decide.

Creating custom strategies

Custom TLspSelectChoice instances can be retrieved using the getInstance method.

When using a custom one, make sure your TLspSelectControllerModel set on the TLspSelectController can handle this choice. On a default TLspSelectControllerModel, this is done by registering a custom ILspSelectionCandidateHandler through the TLspSelectControllerModel.setSelectionCandidateHandlerFor(TLspSelectChoice, ILspSelectionCandidateHandler) method.

You also want to use a custom TLspSelectController where the selectChoice method is modified to return your custom choice when applicable.

Since:

2012.0

Field Summary

Fields

Modifier and Type	Field	Description
static final TLspSelectChoice	CHOOSE	Choice indicating to the TLspSelectController and TLspSelectControllerModel that the user can choose one or more selection candidates for which the selection is actually applied.
static final TLspSelectChoice	DEFAULT	The default choice for which the TLspSelectController and TLspSelectControllerModel will select the topmost object when trying to select overlapping objects.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final TLspSelectChoice DEFAULT

The default choice for which the TLspSelectController and TLspSelectControllerModel will select the topmost object when trying to select overlapping objects.

See TLspSelectControllerModel.applySelection(ALspSelectInput, TLspSelectChoice, TLspSelectMode, List, ILspView) for more details on how the default select controller handles this choice.

CHOOSE

public static final TLspSelectChoice CHOOSE

Choice indicating to the TLspSelectController and TLspSelectControllerModel that the user can choose one or more selection candidates for which the selection is actually applied.

See TLspSelectControllerModel.applySelection(ALspSelectInput, TLspSelectChoice, TLspSelectMode, List, ILspView) for more details on how the default select controller handles this choice.

Method Details

getInstance

public static TLspSelectChoice getInstance(String aName)

Returns an instance of a TLspSelectChoice based on a name.

Parameters:

aName - the name of the TLspSelectChoice.

Returns:

the TLspSelectChoice.

getName

public String getName()

Returns the name of this select choice.

Returns:

the name.

toString

public String toString()

Returns the name of this select choice.

Overrides:

toString in class Object

Returns:

the name.