|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pivot.wtk.Component
org.apache.pivot.wtk.Container
org.apache.pivot.wtk.Spinner
@DefaultProperty(value="spinnerData") public class Spinner
Component that presents a means of cycling through a list of items.
Nested Class Summary | |
---|---|
static interface |
Spinner.ItemBindMapping
Translates between spinner and bind context data during data binding. |
static interface |
Spinner.ItemRenderer
Renderer interface to customize the appearance of the data in a Spinner. |
static interface |
Spinner.Skin
Spinner skin interface. |
static interface |
Spinner.SpinnerDataBindMapping
Translates between spinner and bind context data during data binding. |
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container |
---|
Container.EDT_Checker |
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component |
---|
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary |
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence |
---|
Sequence.Tree<T> |
Constructor Summary | |
---|---|
Spinner()
Creates a spinner populated with an empty array list. |
|
Spinner(List<?> spinnerData)
Creates a spinner populated with the given spinner data. |
Method Summary | |
---|---|
void |
clear()
Propagates clear operation to subcomponents. |
void |
clearSelection()
Clears the selection. |
Bounds |
getContentBounds()
Gets the bounding area of the spinner content (the area in which the item renderer will render the content). |
Spinner.ItemRenderer |
getItemRenderer()
Returns the item renderer used for items in this list. |
int |
getSelectedIndex()
Returns the currently selected index. |
Object |
getSelectedItem()
|
Spinner.ItemBindMapping |
getSelectedItemBindMapping()
|
BindType |
getSelectedItemBindType()
|
String |
getSelectedItemKey()
|
ListenerList<SpinnerBindingListener> |
getSpinnerBindingListeners()
Returns the spinner binding listener list. |
List<?> |
getSpinnerData()
Returns the spinner data. |
Spinner.SpinnerDataBindMapping |
getSpinnerDataBindMapping()
|
BindType |
getSpinnerDataBindType()
|
String |
getSpinnerDataKey()
|
ListenerList<SpinnerItemListener> |
getSpinnerItemListeners()
Returns the spinner item listener list. |
ListenerList<SpinnerListener> |
getSpinnerListeners()
Returns the spinner listener list. |
ListenerList<SpinnerSelectionListener> |
getSpinnerSelectionListeners()
Returns the spinner selection listener list. |
boolean |
isCircular()
|
void |
load(Object context)
Propagates binding to subcomponents. |
void |
setCircular(boolean circular)
|
void |
setItemRenderer(Spinner.ItemRenderer itemRenderer)
Sets the item renderer to be used for items in this list. |
void |
setSelectedIndex(int selectedIndex)
Sets the selection to the specified index. |
void |
setSelectedItem(Object item)
|
void |
setSelectedItemBindMapping(Spinner.ItemBindMapping selectedItemBindMapping)
|
void |
setSelectedItemBindType(BindType selectedItemBindType)
|
void |
setSelectedItemKey(String selectedItemKey)
|
protected void |
setSkin(Skin skin)
Sets the skin, replacing any previous skin. |
void |
setSpinnerData(List<?> spinnerData)
Sets the spinner data. |
void |
setSpinnerData(String spinnerData)
|
void |
setSpinnerDataBindMapping(Spinner.SpinnerDataBindMapping spinnerDataBindMapping)
|
void |
setSpinnerDataBindType(BindType spinnerDataBindType)
|
void |
setSpinnerDataKey(String spinnerDataKey)
|
void |
store(Object context)
Propagates binding to subcomponents. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Spinner()
The default contents is an ImmutableList
so that
if the default property (which is "spinnerData") is invoked in a BXML
file, BXMLSerializer
trying to add to this immutable sequence
will catch an exception and will do a setSpinnerData(List>)
instead.
public Spinner(List<?> spinnerData)
Note that the default renderer uses (as last option) the toString method on list elements, so override it to return whatever you want to display as text, or implement your own custom renderer.
spinnerData
- The data to set.SpinnerItemRenderer
Method Detail |
---|
public List<?> getSpinnerData()
public void setSpinnerData(List<?> spinnerData)
spinnerData
- The data to be presented by the spinner.public final void setSpinnerData(String spinnerData)
protected void setSkin(Skin skin)
Component
setSkin
in class Component
skin
- The new skin.public Spinner.ItemRenderer getItemRenderer()
public void setItemRenderer(Spinner.ItemRenderer itemRenderer)
itemRenderer
- The item renderer for the list.public boolean isCircular()
public void setCircular(boolean circular)
public int getSelectedIndex()
public void setSelectedIndex(int selectedIndex)
selectedIndex
- The index to select, or -1 to clear the selection.public Object getSelectedItem()
public void setSelectedItem(Object item)
public String getSpinnerDataKey()
public void setSpinnerDataKey(String spinnerDataKey)
public BindType getSpinnerDataBindType()
public void setSpinnerDataBindType(BindType spinnerDataBindType)
public Spinner.SpinnerDataBindMapping getSpinnerDataBindMapping()
public void setSpinnerDataBindMapping(Spinner.SpinnerDataBindMapping spinnerDataBindMapping)
public String getSelectedItemKey()
public void setSelectedItemKey(String selectedItemKey)
public BindType getSelectedItemBindType()
public void setSelectedItemBindType(BindType selectedItemBindType)
public Spinner.ItemBindMapping getSelectedItemBindMapping()
public void setSelectedItemBindMapping(Spinner.ItemBindMapping selectedItemBindMapping)
public void load(Object context)
Container
load
in class Container
public void store(Object context)
Container
store
in class Container
public void clear()
Container
clear
in class Container
public void clearSelection()
public Bounds getContentBounds()
public ListenerList<SpinnerListener> getSpinnerListeners()
public ListenerList<SpinnerItemListener> getSpinnerItemListeners()
public ListenerList<SpinnerSelectionListener> getSpinnerSelectionListeners()
public ListenerList<SpinnerBindingListener> getSpinnerBindingListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |