Package com.iizix.prop.ui.selection
Class RadioSelection
- java.lang.Object
- com.iizix.prop.ui.selection.RadioSelection
- All Implemented Interfaces:
IUIBooleanSelection
,IUIIndexedSelection
,IUISelection
,IUISingleIndexedSelection
public class RadioSelection extends java.lang.Object implements IUIBooleanSelection, IUISingleIndexedSelection
The boolean on/off (or selected/unselected) selection state.- Author:
- Christopher Mindus
Field Summary
Fields inherited from interface com.iizix.prop.ui.selection.IUISingleIndexedSelection
EMPTY
Constructor Summary
Constructors Constructor Description RadioSelection(IUIRadioComponent source, boolean isSelected, int selectedIndex)
Constructor.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
Equals.IUIRadioComponent
getBooleanSource()
Get the source component of the event.IUIRadioComponent
getIndexedSource()
Get the source component of the event.int
getSelectedIndex()
Gets the first selected index.int[]
getSelectedIndicies()
Gets the selected indicies.IUIRadioComponent
getSingleIndexedSource()
Get the source component of the event.IUIRadioComponent
getSource()
Get the source component of the event.UIComp
getUISource()
Gets the UI component being the source of the event.boolean
isOFF()
Returns if the selection is "off".boolean
isON()
Returns if the selection is "on".boolean
isSelected()
Returns the selection state.boolean
isUnselected()
Returns if the selection is not set.java.lang.String
toString()
Converts the selection to a string.Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.iizix.prop.ui.selection.IUISelection
asAnimatedSingleIndexedSelection, asBooleanSelection, asCellSelection, asIndexedSelection, asSingleIndexedSelection, asTriStateSelection
Methods inherited from interface com.iizix.prop.ui.selection.IUISingleIndexedSelection
getFirstSelectedIndex
Constructor Detail
RadioSelection
public RadioSelection(IUIRadioComponent source, boolean isSelected, int selectedIndex)
Constructor.- Parameters:
source
- The component source.isSelected
- The selection state.selectedIndex
- The selected index, or -1 for none.
Method Detail
getSource
public IUIRadioComponent getSource()
Get the source component of the event.- Specified by:
getSource
in interfaceIUISelection
- Returns:
- The source.
getUISource
public UIComp getUISource()
Gets the UI component being the source of the event.- Specified by:
getUISource
in interfaceIUISelection
- Returns:
- The UI component.
isSelected
public boolean isSelected()
Returns the selection state.- Specified by:
isSelected
in interfaceIUIBooleanSelection
- Returns:
- true if selected, false if unselected.
isUnselected
public boolean isUnselected()
Returns if the selection is not set.- Specified by:
isUnselected
in interfaceIUIBooleanSelection
- Returns:
- true if unselected, true if selected.
isON
public boolean isON()
Returns if the selection is "on".- Specified by:
isON
in interfaceIUIBooleanSelection
- Returns:
- true if on, false otherwise.
isOFF
public boolean isOFF()
Returns if the selection is "off".- Specified by:
isOFF
in interfaceIUIBooleanSelection
- Returns:
- true if off, true otherwise.
getBooleanSource
public IUIRadioComponent getBooleanSource()
Get the source component of the event.- Specified by:
getBooleanSource
in interfaceIUIBooleanSelection
- Returns:
- The boolean-type component.
getSelectedIndex
public int getSelectedIndex()
Gets the first selected index.- Specified by:
getSelectedIndex
in interfaceIUISingleIndexedSelection
- Returns:
- The first index in the current selection, or -1 for none.
getSelectedIndicies
public int[] getSelectedIndicies()
Gets the selected indicies.- Specified by:
getSelectedIndicies
in interfaceIUIIndexedSelection
- Specified by:
getSelectedIndicies
in interfaceIUISingleIndexedSelection
- Returns:
- A new array of the selected indices (that may be modified to your liking), or a static zero in length array for no selection.
getIndexedSource
public IUIRadioComponent getIndexedSource()
Get the source component of the event.- Specified by:
getIndexedSource
in interfaceIUIIndexedSelection
- Specified by:
getIndexedSource
in interfaceIUISingleIndexedSelection
- Returns:
- The indexed-type component.
getSingleIndexedSource
public IUIRadioComponent getSingleIndexedSource()
Get the source component of the event.- Specified by:
getSingleIndexedSource
in interfaceIUISingleIndexedSelection
- Returns:
- The single-indexed-type component.
equals
public boolean equals(java.lang.Object o)
Equals.- Overrides:
equals
in classjava.lang.Object
toString
public java.lang.String toString()
Converts the selection to a string.- Overrides:
toString
in classjava.lang.Object