public interface ISelectionTracker
IFactory.newSelectionTracker()
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Integer[]> |
getActiveSelection()
Returns the active selection (which is the last element of the array returned by
getCgSelections() ). |
java.lang.String |
getActiveSelectionString(IRepProcessor repProc)
Returns the selection string of the active selection.
|
java.util.List<java.lang.Integer[]>[] |
getCgSelections()
Returns the selections (list of unit links) for the 10 control groups and an extra one for the active selection.
A selection is a list of arrays holding the link and tag of a unit. |
java.lang.String |
getSelectionString(int controlGroupIndex,
IRepProcessor repProc)
Returns an HTML formatted string representation of the selection specified by its control group index.
The returned string might contain HTML formatting elements but does not start with the <html> tag. |
void |
processControlGroupUpdate(IControlGroupUpdateEvent event)
Processes the specified
IControlGroupUpdateEvent , updates the denoted control group selection. |
void |
processSelectionDelta(ISelectionDeltaEvent event)
Processes the specified
ISelectionDeltaEvent , updates the denoted control group selection. |
java.util.List<java.lang.Integer[]>[] getCgSelections()
getActiveSelection()
java.util.List<java.lang.Integer[]> getActiveSelection()
getCgSelections()
).getCgSelections()
void processSelectionDelta(ISelectionDeltaEvent event)
ISelectionDeltaEvent
, updates the denoted control group selection.event
- selection delta event to be processedprocessControlGroupUpdate(IControlGroupUpdateEvent)
void processControlGroupUpdate(IControlGroupUpdateEvent event)
IControlGroupUpdateEvent
, updates the denoted control group selection.event
- control group update event to be processedprocessSelectionDelta(ISelectionDeltaEvent)
java.lang.String getSelectionString(int controlGroupIndex, IRepProcessor repProc)
<html>
tag.controlGroupIndex
- index of the control group whose string representation to return, must be in the range of 0..11 (the last one is the active
selection)repProc
- reference to the rep processor in case additional info is required (e.g. unit names)java.lang.String getActiveSelectionString(IRepProcessor repProc)
getSelectionString(int, IRepProcessor)
for more details.repProc
- reference to the rep processor in case additional info is required (e.g. unit names)getSelectionString(int, IRepProcessor)
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.