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 Detail

      • EMPTY

        static final int[] EMPTY
        The empty selection indexes.
    • 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 interface IUIIndexedSelection
        Returns:
        The first index in the current selection, or -1 for none.
      • getSelectedIndicies

        default int[] getSelectedIndicies()
        Gets the selected indicies.
        Specified by:
        getSelectedIndicies in interface IUIIndexedSelection
        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.
      • getSingleIndexedSource

        IUISingleIndexedSelectionComp getSingleIndexedSource()
        Get the source component of the event.
        Returns:
        The single-indexed-type component.