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

public class Spinner
extends Container

Component that presents a means of cycling through a list of items.


Nested Class Summary
static interface Spinner.ItemRenderer
          Spinner renderer interface.
static interface Spinner.Skin
          Spinner skin interface.
 
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component
Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
Sequence.Tree
 
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
 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()
           
 String getSelectedItemKey()
          Gets the data binding key that is set on this spinner.
 List<?> getSpinnerData()
          Returns the spinner data.
 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(Dictionary<String,?> 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 setSelectedItemKey(String selectedItemKey)
          Sets this spinner's data binding key.
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 store(Dictionary<String,?> context)
          Propagates binding to subcomponents.
 
Methods inherited from class org.apache.pivot.wtk.Container
add, containsFocus, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, remove, removeAll, requestFocus, setContextKey, setFocusTraversalPolicy, setParent, setTooltip, setVisible, transferFocus, update, validate
 
Methods inherited from class org.apache.pivot.wtk.Component
clearFocus, getAttributes, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponents, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHandle, getHeight, getLocation, getMaximumPreferredHeight, getMaximumPreferredWidth, getMenuHandler, getMinimumPreferredHeight, getMinimumPreferredWidth, getParent, getPreferredHeight, getPreferredHeight, getPreferredHeightLimits, getPreferredSize, getPreferredWidth, getPreferredWidth, getPreferredWidthLimits, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, load, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDragSource, setDropTarget, setEnabled, setHeight, setLocation, setLocation, setMaximumPreferredHeight, setMaximumPreferredWidth, setMenuHandler, setMinimumPreferredHeight, setMinimumPreferredWidth, setPreferredHeight, setPreferredHeightLimits, setPreferredHeightLimits, setPreferredSize, setPreferredSize, setPreferredWidth, setPreferredWidthLimits, setPreferredWidthLimits, setSize, setSize, setStyles, setStyles, setStyles, setTooltipText, setWidth, setX, setY, store, toString, transferFocus
 
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.


Spinner

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

Parameters:
spinnerData -
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 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)

getSelectedItemKey

public String getSelectedItemKey()
Gets the data binding key that is set on this spinner.


setSelectedItemKey

public void setSelectedItemKey(String selectedItemKey)
Sets this spinner's data binding key.


load

public void load(Dictionary<String,?> context)
Description copied from class: Container
Propagates binding to subcomponents. If this container has a binding set, propagates the bound value as a nested context.

Overrides:
load in class Container

store

public void store(Dictionary<String,?> context)
Description copied from class: Container
Propagates binding to subcomponents. If this container has a binding set, propagates the bound value as a nested context.

Overrides:
store in class Container

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.