org.apache.pivot.wtk
Class TabPane

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

@DefaultProperty(value="tabs")
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.


Nested Class Summary
static interface TabPane.Skin
          Tab pane skin interface.
 class TabPane.TabSequence
          Tab sequence implementation.
 
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
TabPane()
           
 
Method Summary
 Component getCorner()
           
 int getSelectedIndex()
           
 Component getSelectedTab()
           
static Object getTabData(Component component)
           
 Button.DataRenderer getTabDataRenderer()
           
 ListenerList<TabPaneAttributeListener> getTabPaneAttributeListeners()
           
 ListenerList<TabPaneListener> getTabPaneListeners()
           
 ListenerList<TabPaneSelectionListener> getTabPaneSelectionListeners()
           
 TabPane.TabSequence getTabs()
           
static String getTooltipText(Component component)
           
 boolean isCloseable()
           
 boolean isCollapsed()
           
 boolean isCollapsible()
           
 boolean isTabVisible(int index)
           
 Sequence<Component> remove(int index, int count)
          Removes one or more items from the sequence.
 void setCloseable(boolean closeable)
           
 void setCollapsed(boolean collapsed)
          Collapse or expand the TabPane (if it is collapsible).
 void setCollapsible(boolean collapsible)
           
 void setCorner(Component corner)
           
 void setSelectedIndex(int selectedIndex)
           
 void setSelectedTab(Component comp)
           
static void setTabData(Component component, Object tabData)
           
 void setTabDataRenderer(Button.DataRenderer tabDataRenderer)
           
 void setTabVisible(int index, boolean value)
           
static void setTooltipText(Component component, String tooltipText)
           
 
Methods inherited from class org.apache.pivot.wtk.Container
add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, 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, setSkin, 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

TabPane

public TabPane()
Method Detail

getTabs

public TabPane.TabSequence getTabs()

getCorner

public Component getCorner()

setCorner

public void setCorner(Component corner)

getSelectedIndex

public int getSelectedIndex()

setSelectedIndex

public void setSelectedIndex(int selectedIndex)

getSelectedTab

public Component getSelectedTab()

setSelectedTab

public void setSelectedTab(Component comp)

getTabDataRenderer

public Button.DataRenderer getTabDataRenderer()

setTabDataRenderer

public void setTabDataRenderer(Button.DataRenderer tabDataRenderer)

isCloseable

public boolean isCloseable()

setCloseable

public void setCloseable(boolean closeable)

isCollapsed

public boolean isCollapsed()
Returns:
true if the TabPane is collapsible and no tab is selected; false, otherwise.
See Also:
isCollapsible(), getSelectedIndex()

setCollapsed

public void setCollapsed(boolean collapsed)
Collapse or expand the TabPane (if it is collapsible).

Parameters:
collapsed - true to collapse, false to expand and select the first tab. Use setSelectedIndex(int) to expand and select a specific Tab.
See Also:
isCollapsible(), setSelectedIndex(int)

isCollapsible

public boolean isCollapsible()

setCollapsible

public void setCollapsible(boolean collapsible)

isTabVisible

public boolean isTabVisible(int index)

setTabVisible

public void setTabVisible(int index,
                          boolean value)

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()

getTabData

public static Object getTabData(Component component)

setTabData

public static void setTabData(Component component,
                              Object tabData)

getTooltipText

public static String getTooltipText(Component component)

setTooltipText

public static void setTooltipText(Component component,
                                  String tooltipText)