Class TriStateSelection

java.lang.Object
com.iizix.prop.ui.selection.TriStateSelection
All Implemented Interfaces:
IUISelection, IUITriStateSelection

public class TriStateSelection extends Object implements IUITriStateSelection
The tri-state selection.
Author:
Christopher Mindus
  • Constructor Details

    • TriStateSelection

      public TriStateSelection(IUITriStateSelectionComp source, int state)
      Constructor.
      Parameters:
      source - The component source.
      state - The check state.
  • Method Details

    • getCheckState

      public int getCheckState()
      Gets the check state.
      Specified by:
      getCheckState in interface IUITriStateSelection
      Returns:
      Returns 0={$link #UNSELECTED}, 1={$link #CHECKED} or 2={$link #THIRD_STATE}.
    • isChecked

      public boolean isChecked()
      Returns if the state is checked.
      Specified by:
      isChecked in interface IUITriStateSelection
      Returns:
      true if checked, false if unselected or in third state.
    • isUnselected

      public boolean isUnselected()
      Returns if the state is unselected.
      Specified by:
      isUnselected in interface IUITriStateSelection
      Returns:
      true if unchecked, false if checked or in third state.
    • isThirdState

      public boolean isThirdState()
      Returns if the state is third state, i.e. neither checked nor unselected.
      Specified by:
      isThirdState in interface IUITriStateSelection
      Returns:
      true if third state, false if checked or unselected.
    • getTriStateSource

      public IUITriStateSelectionComp getTriStateSource()
      Get the source component of the event.
      Specified by:
      getTriStateSource in interface IUITriStateSelection
      Returns:
      The tri-state based component.
    • getSource

      public IUISelectionComp getSource()
      Get the source component of the event.
      Specified by:
      getSource in interface IUISelection
      Returns:
      The selection component.
    • getUISource

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

      public boolean equals(Object o)
      Equals.
      Overrides:
      equals in class Object
    • toString

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