org.apache.pivot.wtk
Class Spinner

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.Spinner
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

@DefaultProperty(value="spinnerData")
public class Spinner
extends Container

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 org.apache.pivot.wtk.Container
add, assertEventDispatchThread, assertEventDispatchThread, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, transferFocus, update
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Spinner

public Spinner()
Creates a spinner populated with an empty array list.

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.


Spinner

public Spinner(List<?> spinnerData)
Creates a spinner populated with the given spinner data.

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.

Parameters:
spinnerData - The data to set.
See Also:
SpinnerItemRenderer
Method Detail

getSpinnerData

public List<?> getSpinnerData()
Returns the spinner data.

Returns:
The data currently presented by the spinner.

setSpinnerData

public void setSpinnerData(List<?> spinnerData)
Sets the spinner data. Clears any existing selection state.

Parameters:
spinnerData - The data to be presented by the spinner.

setSpinnerData

public final void setSpinnerData(String spinnerData)

setSkin

protected void setSkin(Skin skin)
Description copied from class: Component
Sets the skin, replacing any previous skin.

Overrides:
setSkin in class Component
Parameters:
skin - The new skin.

getItemRenderer

public Spinner.ItemRenderer getItemRenderer()
Returns the item renderer used for items in this list.


setItemRenderer

public void setItemRenderer(Spinner.ItemRenderer itemRenderer)
Sets the item renderer to be used for items in this list.

Parameters:
itemRenderer - The item renderer for the list.

isCircular

public boolean isCircular()

setCircular

public void setCircular(boolean circular)

getSelectedIndex

public int getSelectedIndex()
Returns the currently selected index.

Returns:
The currently selected index.

setSelectedIndex

public void setSelectedIndex(int selectedIndex)
Sets the selection to the specified index.

Parameters:
selectedIndex - The index to select, or -1 to clear the selection.

getSelectedItem

public Object getSelectedItem()

setSelectedItem

public void setSelectedItem(Object item)

getSpinnerDataKey

public String getSpinnerDataKey()

setSpinnerDataKey

public void setSpinnerDataKey(String spinnerDataKey)

getSpinnerDataBindType

public BindType getSpinnerDataBindType()

setSpinnerDataBindType

public void setSpinnerDataBindType(BindType spinnerDataBindType)

getSpinnerDataBindMapping

public Spinner.SpinnerDataBindMapping getSpinnerDataBindMapping()

setSpinnerDataBindMapping

public void setSpinnerDataBindMapping(Spinner.SpinnerDataBindMapping spinnerDataBindMapping)

getSelectedItemKey

public String getSelectedItemKey()

setSelectedItemKey

public void setSelectedItemKey(String selectedItemKey)

getSelectedItemBindType

public BindType getSelectedItemBindType()

setSelectedItemBindType

public void setSelectedItemBindType(BindType selectedItemBindType)

getSelectedItemBindMapping

public Spinner.ItemBindMapping getSelectedItemBindMapping()

setSelectedItemBindMapping

public void setSelectedItemBindMapping(Spinner.ItemBindMapping selectedItemBindMapping)

load

public void load(Object context)
Description copied from class: Container
Propagates binding to subcomponents.

Overrides:
load in class Container

store

public void store(Object context)
Description copied from class: Container
Propagates binding to subcomponents.

Overrides:
store in class Container

clear

public void clear()
Description copied from class: Container
Propagates clear operation to subcomponents.

Overrides:
clear in class Container

clearSelection

public void clearSelection()
Clears the selection.


getContentBounds

public Bounds getContentBounds()
Gets the bounding area of the spinner content (the area in which the item renderer will render the content).

Returns:
The bounding area of the spinner content.

getSpinnerListeners

public ListenerList<SpinnerListener> getSpinnerListeners()
Returns the spinner listener list.


getSpinnerItemListeners

public ListenerList<SpinnerItemListener> getSpinnerItemListeners()
Returns the spinner item listener list.


getSpinnerSelectionListeners

public ListenerList<SpinnerSelectionListener> getSpinnerSelectionListeners()
Returns the spinner selection listener list.


getSpinnerBindingListeners

public ListenerList<SpinnerBindingListener> getSpinnerBindingListeners()
Returns the spinner binding listener list.