org.wings
Class STabbedPane

java.lang.Object
  org.wings.SComponent
      org.wings.SContainer
          org.wings.STabbedPane

All Implemented Interfaces:

Serializable, Cloneable, LowLevelEventListener, Renderable

public class STabbedPane
extends SContainer
implements LowLevelEventListener

Shows one tab, usually a panel, at a time and allows switching between them.

Author:

Armin Haaf, Andre Lison

See Also:

Serialized Form

Field Summary

protected int	maxTabsPerLine the maximum tabs per line
protected SingleSelectionModel	model The default selection model
protected int	selectedIndex Number of selected tab.
static Selector	SELECTOR_CONTENT A Pseudo selector addressing the container area of this container.
static Selector	SELECTOR_DISABLED_TAB A Pseudo CSS selector addressing the unselected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)
static Selector	SELECTOR_SELECTED_TAB A Pseudo CSS selector addressing the selected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)
static Selector	SELECTOR_TABS A Pseudo CSS selector addressing the area which contains the tab buttons.
static Selector	SELECTOR_UNSELECTED_TAB A Pseudo CSS selector addressing the unselected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)
protected int	tabPlacement Where the tabs are placed.

Fields inherited from class org.wings.SComponent

DONE_RENDERING, dynamicStyles, enabled, propertyChangeSupport, SELECTOR_ALL, START_RENDERING, visible, WHEN_FOCUSED_OR_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_IN_FOCUSED_FRAME

Constructor Summary

STabbedPane()
Creates a new empty Tabbed Pane with the tabs at the top.

STabbedPane(int tabPlacement)
Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Method Summary

SComponent	add(String title, SComponent component) Adds a component with the specified tab title.
void	addChangeListener(ChangeListener cl) Add a listener to the list of change listeners.
SComponent	addComponent(SComponent component, Object constraints) Adds a component at the specified tab index.
SComponent	addComponent(SComponent component, Object constraints, int index) Adds a component at the specified tab index.
void	addTab(String title, SComponent component) Adds a component represented by a title and no icon.
void	addTab(String title, SIcon icon, SComponent component) Adds a component represented by a title and/or icon, either of which can be null.
void	addTab(String title, SIcon icon, SComponent component, String tip) Adds a component and tip represented by a title and/or icon, either of which can be null.
void	fireFinalEvents() Sets selection and fire changeevents, if user changed tab selection.
void	fireIntermediateEvents() Does nothin'.
protected void	fireStateChanged() Fire ChangeEvents at all registered change listeners.
Color	getBackgroundAt(int index) Returns the tab background color at index.
SComponent	getComponentAt(int index) Returns the component at index.
SIcon	getDisabledIconAt(int index) Returns the tab disabled icon at index.
Color	getForegroundAt(int index) Returns the tab foreground color at index.
SIcon	getIconAt(int index) Returns the tab icon at index.
int	getMaxTabsPerLine() Returns the maximum tabs per line.
SingleSelectionModel	getModel() Returns the model associated with this tabbedpane.
SComponent	getSelectedComponent() Returns the currently selected component for this tabbedpane.
int	getSelectedIndex() Returns the currently selected index for this tabbedpane.
Color	getSelectionBackground() Return the background color.
SFont	getSelectionFont() Return the font.
Color	getSelectionForeground() Return the foreground color.
String	getStyleAt(int index) Returns the tab style at index.
int	getTabCount() Returns the number of tabs in this tabbedpane.
int	getTabPlacement() Returns the placement of the tabs for this tabbedpane.
String	getTitleAt(int index) Returns the tab title at index.
String	getToolTipTextAt(int index) Get the tooltip text from tab at index
int	indexOfComponent(SComponent component) Returns the index of the tab for the specified component.
int	indexOfTab(SIcon icon) Returns the first tab index with a given icon.
int	indexOfTab(String title) Returns the first tab index with a given title, Returns -1 if no tab has this title.
void	insertTab(String title, SIcon icon, SComponent component, String tip, int index) Inserts a component, at index, represented by a title and/or icon, either of which may be null.
boolean	isEnabledAt(int index) Returns whether or not the tab at index is currently enabled.
boolean	isEpochCheckEnabled() Asks the low-level event listener if epoch checking should be perfomed on it.
void	processLowLevelEvent(String action, String[] values) Tab was clicked.
void	remove(SComponent component) Removes the tab which corresponds to the specified component.
void	removeAllTabs()
void	removeChangeListener(ChangeListener cl) Remove listener from the list of change listeners.
void	removeTabAt(int index) Removes the tab at index.
void	setBackgroundAt(int index, Color background) Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane.
void	setCG(TabbedPaneCG cg)
void	setComponent(int index, SComponent component) Sets the component at index to component.
void	setComponentAt(int index, SComponent component) Sets the component at index to component which must not be null.
void	setDisabledIconAt(int index, SIcon disabledIcon) Sets the disabled icon at index to icon which can be null.
void	setEnabledAt(int index, boolean enabled) Sets whether or not the tab at index is enabled.
void	setEpochCheckEnabled(boolean epochCheckEnabled)
void	setForegroundAt(int index, Color foreground) Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane.
void	setIconAt(int index, SIcon icon) Sets the icon at index to icon which can be null.
void	setMaxTabsPerLine(int tabs) Sets the maximum tabs per line.
void	setModel(SingleSelectionModel model) Sets the model to be used with this tabbedpane.
void	setParentFrame(SFrame f) Set the parent frame of this tabbed pane
void	setSelectedComponent(SComponent c) Sets the selected component for this tabbedpane.
void	setSelectedIndex(int index) Sets the selected index for this tabbedpane.
void	setSelectionBackground(Color color) Set the foreground color.
void	setSelectionFont(SFont font) Set the font.
void	setSelectionForeground(Color color) Set the foreground color.
void	setStyleAt(int index, String style) Sets the style at index to style which can be null, in which case the tab's style will default to the style of this tabbedpane.
void	setTabPlacement(int tabPlacement) Sets the tab placement for this tabbedpane.
void	setTitleAt(int index, String title) Sets the title at index to title which can be null.
void	setToolTipTextAt(int index, String toolTip) Set the tooltip text for tab at index

Methods inherited from class org.wings.SContainer

add, add, add, add, addComponent, addComponent, addContainerListener, addNotify, clone, fireContainerEvent, getComponent, getComponentCount, getComponentList, getComponents, getConstraintAt, getConstraintList, getLayout, invite, inviteEachComponent, isShowingChildren, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setCG, setLayout, updateCG

Methods inherited from class org.wings.SComponent

addComponentListener, addDynamicStyle, addEventListener, addParentFrameListener, addPropertyChangeListener, addPropertyChangeListener, addRenderListener, addScriptListener, addStyle, fireComponentChangeEvent, fireKeyEvents, fireRenderEvent, getActionMap, getBackground, getBorder, getCG, getClientProperty, getComponentPopupMenu, getDynamicStyle, getDynamicStyles, getFocusTraversalIndex, getFont, getForeground, getHorizontalAlignment, getInputMap, getInputMap, getListenerCount, getListenerList, getListeners, getLowLevelEventId, getName, getParent, getParentFrame, getPreferredSize, getRequestURL, getResidesInForm, getScriptListenerList, getScriptListeners, getSession, getShowAsFormComponent, getStyle, getToolTipText, getVerticalAlignment, isDifferent, isEnabled, isFocusOwner, isRecursivelyVisible, isReloadForced, isUpdatePossible, isVisible, paramString, processComponentEvent, processKeyEvents, putClientProperty, reload, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, removeComponentListener, removeDynamicStyle, removeEventListener, removeParentFrameListener, removePropertyChangeListener, removePropertyChangeListener, removeRenderListener, removeScriptListener, removeStyle, requestFocus, scrollRectToVisible, setActionMap, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes, setBackground, setBorder, setCG, setComponentPopupMenu, setDynamicStyles, setEnabled, setFocusTraversalIndex, setFont, setForeground, setHorizontalAlignment, setInputMap, setInputMap, setName, setNameRaw, setParent, setPreferredSize, setReloadForced, setShowAsFormComponent, setStyle, setToolTipText, setVerticalAlignment, setVisible, toString, update, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.wings.LowLevelEventListener

getLowLevelEventId, getName, isEnabled

Field Detail

SELECTOR_CONTENT

public static final Selector SELECTOR_CONTENT

A Pseudo selector addressing the container area of this container. Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)

SELECTOR_TABS

public static final Selector SELECTOR_TABS

A Pseudo CSS selector addressing the area which contains the tab buttons. Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)

SELECTOR_SELECTED_TAB

public static final Selector SELECTOR_SELECTED_TAB

A Pseudo CSS selector addressing the selected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)

SELECTOR_UNSELECTED_TAB

public static final Selector SELECTOR_UNSELECTED_TAB

A Pseudo CSS selector addressing the unselected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)

SELECTOR_DISABLED_TAB

public static final Selector SELECTOR_DISABLED_TAB

A Pseudo CSS selector addressing the unselected tab Refer to SComponent.setAttribute(org.wings.style.Selector, org.wings.style.CSSProperty, String)

tabPlacement

protected int tabPlacement

Where the tabs are placed.

See Also:

setTabPlacement(int)

model

protected SingleSelectionModel model

The default selection model

maxTabsPerLine

protected int maxTabsPerLine

the maximum tabs per line

selectedIndex

protected int selectedIndex

Number of selected tab.

Constructor Detail

STabbedPane

public STabbedPane()

Creates a new empty Tabbed Pane with the tabs at the top.

See Also:

addTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String)

STabbedPane

public STabbedPane(int tabPlacement)

Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Parameters:

tabPlacement - the placement for the tabs relative to the content

See Also:

addTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String)

Method Detail

getSelectionBackground

public Color getSelectionBackground()

Return the background color.

Returns:

the background color

setSelectionBackground

public void setSelectionBackground(Color color)

Set the foreground color.

Parameters:

color - the new foreground color

getSelectionForeground

public Color getSelectionForeground()

Return the foreground color.

Returns:

the foreground color

setSelectionForeground

public void setSelectionForeground(Color color)

Set the foreground color.

Parameters:

color - the new foreground color

setSelectionFont

public void setSelectionFont(SFont font)

Set the font.

Parameters:

font - the new font

getSelectionFont

public SFont getSelectionFont()

Return the font.

Returns:

the font

addChangeListener

public void addChangeListener(ChangeListener cl)

Add a listener to the list of change listeners. ChangeListeners are notified, when the tab selection changes.

Parameters:

cl - add to listener list

removeChangeListener

public void removeChangeListener(ChangeListener cl)

Remove listener from the list of change listeners. ChangeListeners are notified, when the tab selection changes.

Parameters:

cl - remove from listener list

fireStateChanged

protected void fireStateChanged()

Fire ChangeEvents at all registered change listeners.

getTabPlacement

public int getTabPlacement()

Returns the placement of the tabs for this tabbedpane.

See Also:

setTabPlacement(int)

setTabPlacement

public void setTabPlacement(int tabPlacement)

Sets the tab placement for this tabbedpane. Possible values are:

• SConstants.TOP
• SConstants.BOTTOM
• SConstants.LEFT
• SConstants.RIGHT

The default value is TOP.

Parameters:

tabPlacement - the placement for the tabs relative to the content

getModel

public SingleSelectionModel getModel()

Returns the model associated with this tabbedpane.

See Also:

setModel(javax.swing.SingleSelectionModel)

setModel

public void setModel(SingleSelectionModel model)

Sets the model to be used with this tabbedpane.

Parameters:

model - the model to be used

See Also:

getModel()

getSelectedIndex

public int getSelectedIndex()

Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab.

Returns:

the index of the selected tab

See Also:

setSelectedIndex(int)

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected index for this tabbedpane.

See Also:

getSelectedIndex(), SingleSelectionModel.setSelectedIndex(int)

getSelectedComponent

public SComponent getSelectedComponent()

Returns the currently selected component for this tabbedpane. Returns null if there is no currently selected tab.

Returns:

the component corresponding to the selected tab

See Also:

setSelectedComponent(org.wings.SComponent)

setSelectedComponent

public void setSelectedComponent(SComponent c)

Sets the selected component for this tabbedpane. This will automatically set the selectedIndex to the index corresponding to the specified component.

See Also:

getSelectedComponent()

indexOfComponent

public int indexOfComponent(SComponent component)

Returns the index of the tab for the specified component. Returns -1 if there is no tab for this component.

Parameters:

component - the component for the tab

getTabCount

public int getTabCount()

Returns the number of tabs in this tabbedpane.

Returns:

an int specifying the number of tabbed pages

insertTab

public void insertTab(String title,
                      SIcon icon,
                      SComponent component,
                      String tip,
                      int index)

Inserts a component, at index, represented by a title and/or icon, either of which may be null. Uses java.util.ArrayList internally, see insertElementAt() for details of insertion conventions.

Parameters:

title - the title to be displayed in this tab

icon - the icon to be displayed in this tab

component - The component to be displayed when this tab is clicked.

tip - the tooltip to be displayed for this tab

index - the position to insert this new tab

See Also:

addTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String), removeTabAt(int)

addTab

public void addTab(String title,
                   SIcon icon,
                   SComponent component,
                   String tip)

Adds a component and tip represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:

title - the title to be displayed in this tab

icon - the icon to be displayed in this tab

component - The component to be displayed when this tab is clicked.

tip - the tooltip to be displayed for this tab

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

addTab

public void addTab(String title,
                   SIcon icon,
                   SComponent component)

Adds a component represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:

title - the title to be displayed in this tab

icon - the icon to be displayed in this tab

component - The component to be displayed when this tab is clicked.

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

addTab

public void addTab(String title,
                   SComponent component)

Adds a component represented by a title and no icon. Cover method for insertTab().

Parameters:

title - the title to be displayed in this tab

component - The component to be displayed when this tab is clicked.

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

add

public SComponent add(String title,
                      SComponent component)

Adds a component with the specified tab title. Cover method for insertTab().

Parameters:

title - the title to be displayed in this tab

component - The component to be displayed when this tab is clicked.

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

addComponent

public SComponent addComponent(SComponent component,
                               Object constraints)

Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Overrides:

addComponent in class SContainer

Parameters:

component - The component to be displayed when this tab is clicked.

constraints - the object to be displayed in the tab

Returns:

the added component

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

addComponent

public SComponent addComponent(SComponent component,
                               Object constraints,
                               int index)

Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Overrides:

addComponent in class SContainer

Parameters:

component - The component to be displayed when this tab is clicked.

constraints - the object to be displayed in the tab

index - the position to insert this new tab

Returns:

the added component

See Also:

insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int), removeTabAt(int)

removeTabAt

public void removeTabAt(int index)

Removes the tab at index. After the component associated with index is removed, its visibility is reset to true to ensure it will be visible if added to other containers.

Parameters:

index - the index of the tab to be removed

See Also:

addTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String), insertTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String, int)

remove

public void remove(SComponent component)

Removes the tab which corresponds to the specified component.

Overrides:

remove in class SContainer

Parameters:

component - the component to remove from the tabbedpane

See Also:

addTab(java.lang.String, org.wings.SIcon, org.wings.SComponent, java.lang.String), removeTabAt(int)

setMaxTabsPerLine

public void setMaxTabsPerLine(int tabs)

Sets the maximum tabs per line. tabs >= 0: No maximum.

getMaxTabsPerLine

public int getMaxTabsPerLine()

Returns the maximum tabs per line.

getComponentAt

public SComponent getComponentAt(int index)

Returns the component at index.

See Also:

setComponentAt(int, org.wings.SComponent)

getTitleAt

public String getTitleAt(int index)

Returns the tab title at index.

See Also:

setTitleAt(int, java.lang.String)

getIconAt

public SIcon getIconAt(int index)

Returns the tab icon at index.

See Also:

setIconAt(int, org.wings.SIcon)

getDisabledIconAt

public SIcon getDisabledIconAt(int index)

Returns the tab disabled icon at index.

See Also:

setDisabledIconAt(int, org.wings.SIcon)

getBackgroundAt

public Color getBackgroundAt(int index)

Returns the tab background color at index.

See Also:

setBackgroundAt(int, java.awt.Color)

getForegroundAt

public Color getForegroundAt(int index)

Returns the tab foreground color at index.

See Also:

setForegroundAt(int, java.awt.Color)

getStyleAt

public String getStyleAt(int index)

Returns the tab style at index.

See Also:

setStyleAt(int, java.lang.String)

isEnabledAt

public boolean isEnabledAt(int index)

Returns whether or not the tab at index is currently enabled.

See Also:

setEnabledAt(int, boolean)

setComponentAt

public void setComponentAt(int index,
                           SComponent component)

Sets the component at index to component which must not be null. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the title should be set

component - the component for the tab

See Also:

getComponentAt(int)

setTitleAt

public void setTitleAt(int index,
                       String title)

Sets the title at index to title which can be null. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the title should be set

title - the title to be displayed in the tab

See Also:

getTitleAt(int)

setIconAt

public void setIconAt(int index,
                      SIcon icon)

Sets the icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the icon should be set

icon - the icon to be displayed in the tab

See Also:

getIconAt(int)

setDisabledIconAt

public void setDisabledIconAt(int index,
                              SIcon disabledIcon)

Sets the disabled icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the disabled icon should be set

disabledIcon - the icon to be displayed in the tab when disabled

See Also:

getDisabledIconAt(int)

setBackgroundAt

public void setBackgroundAt(int index,
                            Color background)

Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the background should be set

background - the color to be displayed in the tab's background

See Also:

getBackgroundAt(int)

setForegroundAt

public void setForegroundAt(int index,
                            Color foreground)

Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the foreground should be set

foreground - the color to be displayed as the tab's foreground

See Also:

getForegroundAt(int)

setStyleAt

public void setStyleAt(int index,
                       String style)

Sets the style at index to style which can be null, in which case the tab's style will default to the style of this tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where the style should be set

style - the style to be used as the tab's style

See Also:

getStyleAt(int)

setEnabledAt

public void setEnabledAt(int index,
                         boolean enabled)

Sets whether or not the tab at index is enabled. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index which should be enabled/disabled

enabled - whether or not the tab should be enabled

See Also:

isEnabledAt(int)

setToolTipTextAt

public void setToolTipTextAt(int index,
                             String toolTip)

Set the tooltip text for tab at index

Parameters:

index - set the tooltip for this tab

getToolTipTextAt

public String getToolTipTextAt(int index)

Get the tooltip text from tab at index

Returns:

the text or null if not set.

setComponent

public void setComponent(int index,
                         SComponent component)

Sets the component at index to component. An internal exception is raised if there is no tab at that index.

Parameters:

index - the tab index where this component is being placed

component - the component for the tab

See Also:

SContainer.getComponent(int)

indexOfTab

public int indexOfTab(String title)

Returns the first tab index with a given title, Returns -1 if no tab has this title.

Parameters:

title - the title for the tab

indexOfTab

public int indexOfTab(SIcon icon)

Returns the first tab index with a given icon. Returns -1 if no tab has this icon.

Parameters:

icon - the icon for the tab

setParentFrame

public void setParentFrame(SFrame f)

Set the parent frame of this tabbed pane

Overrides:

setParentFrame in class SContainer

Parameters:

f - the parent frame.

setCG

public void setCG(TabbedPaneCG cg)

processLowLevelEvent

public void processLowLevelEvent(String action,
                                 String[] values)

Tab was clicked.

Specified by:

processLowLevelEvent in interface LowLevelEventListener

Overrides:

processLowLevelEvent in class SComponent

Parameters:

action - the name-value-pair's name

values - the name-value-pair's values

See Also:

LowLevelEventListener.processLowLevelEvent(String, String[])

fireIntermediateEvents

public void fireIntermediateEvents()

Does nothin'.

Specified by:

fireIntermediateEvents in interface LowLevelEventListener

fireFinalEvents

public void fireFinalEvents()

Sets selection and fire changeevents, if user changed tab selection.

Specified by:

fireFinalEvents in interface LowLevelEventListener

Overrides:

fireFinalEvents in class SComponent

isEpochCheckEnabled

public boolean isEpochCheckEnabled()

Description copied from interface: LowLevelEventListener

Asks the low-level event listener if epoch checking should be perfomed on it. If true the Dispatcher will ignore request originating from old views (typically iniated by triggering browser back and clicking somewhere.)

Specified by:

isEpochCheckEnabled in interface LowLevelEventListener

Returns:

true if epoch checking should be perfomed, false if all request for this component should be processed.

See Also:

LowLevelEventListener.isEpochCheckEnabled()

setEpochCheckEnabled

public void setEpochCheckEnabled(boolean epochCheckEnabled)

See Also:

LowLevelEventListener.isEpochCheckEnabled()

removeAllTabs

public void removeAllTabs()