Package com.iizix.prop.ui.selection
Interface IUITriStateSelection
- All Superinterfaces:
IUISelection
- All Known Implementing Classes:
TriStateSelection
public interface IUITriStateSelection extends IUISelection
The boolean selection is used for radio buttons and others when box type components (menu item) where the state can be checked, third state or unchecked.- Author:
- Christopher Mindus
Field Summary
Fields Modifier and Type Field Description static int
CHECKED
The state: checked.static int
THIRD_STATE
The state: third state.static int
UNSELECTED
The state: unselected.
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCheckState()
Gets the check state.IUITriStateSelectionComp
getTriStateSource()
Get the source component of the event.boolean
isChecked()
Returns if the state is checked.boolean
isThirdState()
Returns if the state is third state, i.e.boolean
isUnselected()
Returns if the state is unselected.Methods inherited from interface com.iizix.prop.ui.selection.IUISelection
asAnimatedSingleIndexedSelection, asBooleanSelection, asCellSelection, asIndexedSelection, asSingleIndexedSelection, asTriStateSelection, getSource, getUISource
Field Detail
UNSELECTED
static final int UNSELECTED
The state: unselected.- See Also:
- Constant Field Values
CHECKED
static final int CHECKED
The state: checked.- See Also:
- Constant Field Values
THIRD_STATE
static final int THIRD_STATE
The state: third state.- See Also:
- Constant Field Values
Method Detail
getCheckState
int getCheckState()
Gets the check state.- Returns:
- Returns 0={$link #UNSELECTED}, 1={$link #CHECKED} or 2={$link #THIRD_STATE}.
isChecked
boolean isChecked()
Returns if the state is checked.- Returns:
- true if checked, false if unselected or in third state.
isUnselected
boolean isUnselected()
Returns if the state is unselected.- Returns:
- true if unchecked, false if checked or in third state.
isThirdState
boolean isThirdState()
Returns if the state is third state, i.e. neither checked nor unselected.- Returns:
- true if third state, false if checked or unselected.
getTriStateSource
IUITriStateSelectionComp getTriStateSource()
Get the source component of the event.- Returns:
- The tri-state based component.