Package com.iizix.prop.ui.selection
Interface IUITriStateSelection
- All Superinterfaces:
IUISelection
- All Known Implementing Classes:
TriStateSelection
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
Modifier and TypeFieldDescriptionstatic final int
The state: checked.static final int
The state: third state.static final int
The state: unselected.Method Summary
Modifier and TypeMethodDescriptionint
Gets the check state.Get the source component of the event.boolean
Returns if the state is checked.boolean
Returns if the state is third state, i.e.boolean
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 Details
UNSELECTED
static final int UNSELECTEDThe state: unselected.- See Also:
CHECKED
static final int CHECKEDThe state: checked.- See Also:
THIRD_STATE
static final int THIRD_STATEThe state: third state.- See Also:
Method Details
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.