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 booleanequals(java.lang.Object o)Equals.IUIRadioComponentgetBooleanSource()Get the source component of the event.IUIRadioComponentgetIndexedSource()Get the source component of the event.intgetSelectedIndex()Gets the first selected index.int[]getSelectedIndicies()Gets the selected indicies.IUIRadioComponentgetSingleIndexedSource()Get the source component of the event.IUIRadioComponentgetSource()Get the source component of the event.UICompgetUISource()Gets the UI component being the source of the event.booleanisOFF()Returns if the selection is "off".booleanisON()Returns if the selection is "on".booleanisSelected()Returns the selection state.booleanisUnselected()Returns if the selection is not set.java.lang.StringtoString()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:
getSourcein interfaceIUISelection- Returns:
- The source.
getUISource
public UIComp getUISource()
Gets the UI component being the source of the event.- Specified by:
getUISourcein interfaceIUISelection- Returns:
- The UI component.
isSelected
public boolean isSelected()
Returns the selection state.- Specified by:
isSelectedin interfaceIUIBooleanSelection- Returns:
- true if selected, false if unselected.
isUnselected
public boolean isUnselected()
Returns if the selection is not set.- Specified by:
isUnselectedin interfaceIUIBooleanSelection- Returns:
- true if unselected, true if selected.
isON
public boolean isON()
Returns if the selection is "on".- Specified by:
isONin interfaceIUIBooleanSelection- Returns:
- true if on, false otherwise.
isOFF
public boolean isOFF()
Returns if the selection is "off".- Specified by:
isOFFin interfaceIUIBooleanSelection- Returns:
- true if off, true otherwise.
getBooleanSource
public IUIRadioComponent getBooleanSource()
Get the source component of the event.- Specified by:
getBooleanSourcein interfaceIUIBooleanSelection- Returns:
- The boolean-type component.
getSelectedIndex
public int getSelectedIndex()
Gets the first selected index.- Specified by:
getSelectedIndexin interfaceIUISingleIndexedSelection- Returns:
- The first index in the current selection, or -1 for none.
getSelectedIndicies
public int[] getSelectedIndicies()
Gets the selected indicies.- Specified by:
getSelectedIndiciesin interfaceIUIIndexedSelection- Specified by:
getSelectedIndiciesin 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:
getIndexedSourcein interfaceIUIIndexedSelection- Specified by:
getIndexedSourcein interfaceIUISingleIndexedSelection- Returns:
- The indexed-type component.
getSingleIndexedSource
public IUIRadioComponent getSingleIndexedSource()
Get the source component of the event.- Specified by:
getSingleIndexedSourcein interfaceIUISingleIndexedSelection- Returns:
- The single-indexed-type component.
equals
public boolean equals(java.lang.Object o)
Equals.- Overrides:
equalsin classjava.lang.Object
toString
public java.lang.String toString()
Converts the selection to a string.- Overrides:
toStringin classjava.lang.Object