pivot.wtk
Class CardPane

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

public class CardPane
extends Container

Container that behaves like a deck of cards, only one of which may be visible at a time.

Author:
gbrown

Nested Class Summary
 
Nested classes/interfaces inherited from class pivot.wtk.Component
Component.Attributes, Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary
 
Nested classes/interfaces inherited from interface pivot.collections.Sequence
Sequence.Search, Sequence.Sort, Sequence.Tree
 
Constructor Summary
CardPane()
           
 
Method Summary
 ListenerList<CardPaneListener> getCardPaneListeners()
           
 Orientation getOrientation()
           
 Component getSelectedCard()
           
 int getSelectedIndex()
          Returns the currently selected card index.
 void insert(Component component, int index)
          Inserts an item into the sequence at a specific index.
 Sequence<Component> remove(int index, int count)
          Removes one or more items from the sequence.
 void setOrientation(Orientation orientation)
           
 void setOrientation(java.lang.String orientation)
           
 void setSelectedIndex(int selectedIndex)
          Sets the selected card index.
 
Methods inherited from class pivot.wtk.Container
add, containsFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, invalidate, isAncestor, isFocusable, isValid, iterator, load, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setEnabled, setFocusTraversalPolicy, setParent, setTooltip, setVisible, store, store, update, validate
 
Methods inherited from class pivot.wtk.Component
clearFocus, clearFocus, finalize, getAttributes, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentDragDropListeners, getComponentKeyListeners, getComponentLayoutListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponents, getComponentStateListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHandle, getHeight, getLocation, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipText, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWindow, getX, getY, installSkin, isBlocked, isDisplayable, isEnabled, isFocused, isMouseOver, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointToAncestor, mouseOver, repaint, repaint, repaint, repaint, repaint, repaint, requestFocus, scrollAreaToVisible, scrollAreaToVisible, setAttributes, setCursor, setCursor, setDisplayable, setDragSource, setDropTarget, setFocused, setLocation, setLocation, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setSkin, setStyles, setStyles, setStyles, setTooltipText, setUserData, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CardPane

public CardPane()
Method Detail

getOrientation

public Orientation getOrientation()

setOrientation

public void setOrientation(Orientation orientation)

setOrientation

public final void setOrientation(java.lang.String orientation)

getSelectedIndex

public int getSelectedIndex()
Returns the currently selected card index.

Returns:
The selected card index, or -1 if no card is selected.

setSelectedIndex

public void setSelectedIndex(int selectedIndex)
Sets the selected card index.

Parameters:
selectedIndex - The selected card index, or -1 for no selection.

getSelectedCard

public Component getSelectedCard()

insert

public void insert(Component component,
                   int index)
Description copied from interface: Sequence
Inserts an item into the sequence at a specific index.

Specified by:
insert in interface Sequence<Component>
Overrides:
insert in class Container
Parameters:
component - The item to be added to the sequence.
index - The index at which the item should be inserted. Must be a value between 0 and getLength().

remove

public Sequence<Component> remove(int index,
                                  int count)
Description copied from interface: Sequence
Removes one or more items from the sequence.

Specified by:
remove in interface Sequence<Component>
Overrides:
remove in class Container
Parameters:
index - The starting index to remove.
count - The number of items to remove, beginning with index.
Returns:
A sequence containing the items that were removed.

getCardPaneListeners

public ListenerList<CardPaneListener> getCardPaneListeners()