Package com.iizix.prop.ui.selection
Interface IUISingleIndexedSelection
- All Superinterfaces:
IUIIndexedSelection
,IUISelection
- All Known Subinterfaces:
IUIAnimatedSingleIndexedSelection
- All Known Implementing Classes:
AnimatedSingleIndexSelection
,RadioSelection
,SingleIndexSelection
public interface IUISingleIndexedSelection extends IUIIndexedSelection
The indexed selection is used for e.g. comboboxes or grids to return or set the selection of rows as indicies.Indexes vs. indices
Indexes and indices are both accepted and widely used plurals of the noun index. Both appear throughout the English-speaking world, but indices prevails in varieties of English from outside North America, while indexes is more common in American and Canadian English. Meanwhile, indices is generally preferred in mathematical, financial, and technical contexts, while indexes is relatively common in general usage.
- Author:
- Christopher Mindus
Field Summary
Fields Modifier and Type Field Description static int[]
EMPTY
The empty selection indexes.
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default int
getFirstSelectedIndex()
Gets the first selected index.default IUIIndexedSelectionComp
getIndexedSource()
Get the source component of the event.int
getSelectedIndex()
Gets the single selected index.default int[]
getSelectedIndicies()
Gets the selected indicies.IUISingleIndexedSelectionComp
getSingleIndexedSource()
Get the source component of the event.Methods inherited from interface com.iizix.prop.ui.selection.IUISelection
asAnimatedSingleIndexedSelection, asBooleanSelection, asCellSelection, asIndexedSelection, asSingleIndexedSelection, asTriStateSelection, getSource, getUISource
Method Detail
getSelectedIndex
int getSelectedIndex()
Gets the single selected index.- Returns:
- The index in the current selection, or -1 for none.
getFirstSelectedIndex
default int getFirstSelectedIndex()
Gets the first selected index.- Specified by:
getFirstSelectedIndex
in interfaceIUIIndexedSelection
- Returns:
- The first index in the current selection, or -1 for none.
getSelectedIndicies
default int[] getSelectedIndicies()
Gets the selected indicies.- Specified by:
getSelectedIndicies
in interfaceIUIIndexedSelection
- Returns:
- A new array of the selected indices (that may be modified to your liking), or a static zero in length array for no selection.
getIndexedSource
default IUIIndexedSelectionComp getIndexedSource()
Get the source component of the event.- Specified by:
getIndexedSource
in interfaceIUIIndexedSelection
- Returns:
- The indexed-type component.
getSingleIndexedSource
IUISingleIndexedSelectionComp getSingleIndexedSource()
Get the source component of the event.- Returns:
- The single-indexed-type component.