pivot.wtk
Class TabPane

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

public class TabPane
extends Container

Container that provides access to a set of components via selectable tabs, only one of which is visible at a time.

TODO Add a getTabAt() method that delegates to the skin.

Author:
gbrown

Nested Class Summary
protected static class TabPane.TabPaneAttributes
          Defines tab attributes.
 class TabPane.TabSequence
          Tab sequence implementation.
 
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
TabPane()
           
TabPane(boolean collapsible)
           
 
Method Summary
 Component getCorner()
           
static Image getIcon(Component component)
           
static java.lang.String getName(Component component)
           
 int getSelectedIndex()
           
 Component getSelectedTab()
           
 Orientation getTabOrientation()
           
 ListenerList<TabPaneAttributeListener> getTabPaneAttributeListeners()
           
 ListenerList<TabPaneListener> getTabPaneListeners()
           
 ListenerList<TabPaneSelectionListener> getTabPaneSelectionListeners()
           
 TabPane.TabSequence getTabs()
           
 boolean isCollapsible()
           
 Sequence<Component> remove(int index, int count)
          Removes one or more items from the sequence.
 void setCollapsible(boolean collapsible)
           
 void setCorner(Component corner)
           
static void setIcon(Component component, Image icon)
           
static void setIcon(Component component, java.lang.String icon)
           
static void setIcon(Component component, java.net.URL icon)
           
static void setName(Component component, java.lang.String name)
           
 void setSelectedIndex(int selectedIndex)
           
 void setTabOrientation(Orientation tabOrientation)
           
 void setTabOrientation(java.lang.String tabOrientation)
           
 
Methods inherited from class pivot.wtk.Container
add, containsFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, 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

TabPane

public TabPane()

TabPane

public TabPane(boolean collapsible)
Method Detail

getTabOrientation

public Orientation getTabOrientation()

setTabOrientation

public void setTabOrientation(Orientation tabOrientation)

setTabOrientation

public void setTabOrientation(java.lang.String tabOrientation)

isCollapsible

public boolean isCollapsible()

setCollapsible

public void setCollapsible(boolean collapsible)

getSelectedIndex

public int getSelectedIndex()

setSelectedIndex

public void setSelectedIndex(int selectedIndex)

getSelectedTab

public Component getSelectedTab()

getTabs

public TabPane.TabSequence getTabs()

getCorner

public Component getCorner()

setCorner

public void setCorner(Component corner)

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.

getTabPaneListeners

public ListenerList<TabPaneListener> getTabPaneListeners()

getTabPaneSelectionListeners

public ListenerList<TabPaneSelectionListener> getTabPaneSelectionListeners()

getTabPaneAttributeListeners

public ListenerList<TabPaneAttributeListener> getTabPaneAttributeListeners()

getName

public static java.lang.String getName(Component component)

setName

public static void setName(Component component,
                           java.lang.String name)

getIcon

public static Image getIcon(Component component)

setIcon

public static void setIcon(Component component,
                           Image icon)

setIcon

public static final void setIcon(Component component,
                                 java.net.URL icon)

setIcon

public static final void setIcon(Component component,
                                 java.lang.String icon)