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:
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.
Modifier and Type | Field and Description |
---|---|
static 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 TLspSelectChoice |
DEFAULT
The default choice for which the
TLspSelectController and TLspSelectControllerModel will select the topmost object when trying to select overlapping objects. |
Modifier and Type | Method and 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.
|
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.
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.
public static TLspSelectChoice getInstance(String aName)
TLspSelectChoice
based on a name.aName
- the name of the TLspSelectChoice
.TLspSelectChoice
.public String getName()