Package com.iizix.prop.ui.selection

Class MultipleIndiciesSelection

java.lang.Object
com.iizix.prop.ui.selection.MultipleIndiciesSelection
All Implemented Interfaces:
IUIIndexedSelection, IUISelection
public class MultipleIndiciesSelection extends Object implements IUIIndexedSelection
The multiple index-based selection state used by e.g. list items or map markers.
Author:
Christopher Mindus

  • Constructor Details

    • MultipleIndiciesSelection

      public MultipleIndiciesSelection(IUISingleIndexedSelectionComp source, int[] selectedIndicies)
      Constructor.
      Parameters:
      source - The component source.
      selectedIndicies - The selected indicies, or null for none.

  • Method Details

    • getSource

      public IUIIndexedSelectionComp getSource()
      Get the source component of the event.
      Specified by:
      getSource in interface IUISelection
      Returns:
      The source.

    • getUISource

      public UIComp getUISource()
      Gets the UI component being the source of the event.
      Specified by:
      getUISource in interface IUISelection
      Returns:
      The UI component.

    • getFirstSelectedIndex

      public 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

      public 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. The array is always sorted from lowest to highest index.

    • getIndexedSource

      public IUIIndexedSelectionComp getIndexedSource()
      Get the source component of the event.
      Specified by:
      getIndexedSource in interface IUIIndexedSelection
      Returns:
      The indexed-type component.

    • equals

      public boolean equals(Object o)
      Equals.

      Note: A single selection can match a multiple selection if both are of no-selection or the same index is selected in both, and the multiple selection indicies array has a length of one.

      Overrides:
      equals in class Object

    • toString

      public String toString()
      Converts the selection to a string.
      Overrides:
      toString in class Object