Package com.iizix.prop.ui.selection

Interface IUITriStateSelectionComp

All Superinterfaces:
IComponent, ICustomDataProvider, IGProp<GProp<?>[]>, IMessageBox, IPropCnr, IUIComp, IUISelectionComp, IVSComponentListener, IVSComponentState, IVSFieldListener
All Known Subinterfaces:
IUICheckComponent
All Known Implementing Classes:
EUICheckBox, EUICheckedMenuItem, UICheckBox, UICheckedMenuItem
public interface IUITriStateSelectionComp extends IUISelectionComp
Interface for tri-state based selection components such as a checkbox.
Author:
Christopher Mindus

  • Method Details

    • getCheckState

      int getCheckState()
      Gets the check state.
      Returns:
      Returns 0={$link com.iizix.prop.ui.IUITriStateSelection#UNSELECTED}, 1={$link com.iizix.prop.ui.IUITriStateSelection#CHECKED} or 2={$link com.iizix.prop.ui.IUITriStateSelection#THIRD_STATE}.

    • isChecked

      boolean isChecked()
      Verifies if the component is checked.
      Returns:
      true if the component is checked, false if unselected or in third state.

    • setChecked

      boolean setChecked(boolean on)
      Sets the checked state.
      Parameters:
      on - The check state.
      Returns:
      true if state is changed, false for no change.

    • setChecked

      boolean setChecked(int state)
      Sets the checked state.
      Parameters:
      state - The check state: 0={$link com.iizix.prop.ui.IUITriStateSelection#UNSELECTED}, 1={$link com.iizix.prop.ui.IUITriStateSelection#CHECKED} or 2={$link com.iizix.prop.ui.IUITriStateSelection#THIRD_STATE}.
      Returns:
      true if state is changed, false for no change or failure (state has wrong value).
      Throws:
      IllegalArgumentException - If the state is not 0-2 (CHECKED, UNSELECTED or THIRD_STATE).