Package com.iizix.prop.ui.selection
Interface IUISelection
- All Known Subinterfaces:
IUIAnimatedSingleIndexedSelection,IUIBooleanSelection,IUICellSelection,IUIIndexedSelection,IUISingleIndexedSelection,IUITriStateSelection
- All Known Implementing Classes:
AnimatedSingleIndexSelection,BooleanSelection,CellSelection,MultipleIndiciesSelection,NoSelection,RadioSelection,SingleIndexSelection,TriStateSelection
public interface IUISelection
The selection interface tag. Every selection event carries an instance of this interface, where the selection can be retrieved in various ways, e.g.:
asIndexedSelection()returningIUIIndexedSelectionasBooleanSelection()returningIUIBooleanSelectionasTriStateSelection()returningIUITriStateSelection
- Author:
- Christopher Mindus
Method Summary
Modifier and TypeMethodDescriptionReturns the selection as an animated single indexed selection.default IUIBooleanSelectionReturns the selection as a boolean selection.default IUICellSelectionReturns the selection as a cell based selection.default IUIIndexedSelectionReturns the selection as an indexed selection.default IUISingleIndexedSelectionReturns the selection as a single indexed selection.default IUITriStateSelectionReturns the selection as a tri-state selection.Get the source component of the event.Gets the UI component being the source of the event.
Method Details
getSource
IUISelectionComp getSource()Get the source component of the event.- Returns:
- The source component.
getUISource
UIComp getUISource()Gets the UI component being the source of the event.- Returns:
- The UI component.
asIndexedSelection
Returns the selection as an indexed selection.- Returns:
- The selection instance, or null if the selection is not an indexed selection.
asSingleIndexedSelection
Returns the selection as a single indexed selection.- Returns:
- The selection instance, or null if the selection is not a single indexed selection.
asAnimatedSingleIndexedSelection
Returns the selection as an animated single indexed selection.- Returns:
- The selection instance, or null if the selection is not an animated single indexed selection.
asBooleanSelection
Returns the selection as a boolean selection.- Returns:
- The selection instance, or null if the selection is not a boolean selection.
asTriStateSelection
Returns the selection as a tri-state selection.- Returns:
- The selection instance, or null if the selection is not a tri-state selection.
asCellSelection
Returns the selection as a cell based selection.- Returns:
- The selection instance, or null if the selection is not a cell based selection.