Tabs/components are added to a TabbedPane object by using the addTab and
insertTab methods. A tab is represented by an index corresponding
to the position it was added in, where the first tab has an index equal to 0
and the last tab has an index equal to the tab count minus 1.
The TabbedPane uses a SingleSelectionModel to represent the set
of tab indeces and the currently selected index. If the tab count
is greater than 0, then there will always be a selected index, which
by default will be initialized to the first tab. If the tab count is
0, then the selected index will be -1.
tabPlacement
protected int tabPlacement
model
protected SingleSelectionModel model
changeListener
protected ChangeListener changeListener
- The changeListener is the listener we add to the
model.
changeEvent
protected transient ChangeEvent changeEvent
- Only one ChangeEvent is needed per TabPane instance since the
event's only (read-only) state is the source property. The source
of events generated here is always "this".
JTabbedPane
public JTabbedPane()
- Creates an empty TabbedPane.
- See Also:
- addTab
JTabbedPane
public JTabbedPane(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
getUI
public TabbedPaneUI getUI()
- Returns the UI object which implements the L&F for this component.
- See Also:
- setUI
setUI
public void setUI(TabbedPaneUI ui)
- Sets the UI object which implements the L&F for this component.
- Parameters:
- ui - the new UI object
- See Also:
- getUI
updateUI
public void updateUI()
- Notification from the UIManager that the L&F has changed.
Called to replace the UI with the latest version from the
default UIFactory.
- Overrides:
- updateUI in class JComponent
- See Also:
- updateUI
getUIClassID
public String getUIClassID()
- Returns the name of the UI class that implements the
L&F for this component.
- Returns:
- "TabbedPaneUI"
- Overrides:
- getUIClassID in class JComponent
- See Also:
- getUIClassID, getUI
createChangeListener
protected ChangeListener createChangeListener()
- Subclasses that want to handle ChangeEvents differently
can override this to return a subclass of ModelListener or
another ChangeListener implementation.
- See Also:
- fireStateChanged
addChangeListener
public void addChangeListener(ChangeListener l)
- Adds a ChangeListener to this tabbedpane.
- Parameters:
- l - the ChangeListener to add
- See Also:
- fireStateChanged, removeChangeListener
removeChangeListener
public void removeChangeListener(ChangeListener l)
- Removes a ChangeListener from this tabbedpane.
- Parameters:
- l - the ChangeListener to remove
- See Also:
- fireStateChanged, addChangeListener
fireStateChanged
protected void fireStateChanged()
- Send a ChangeEvent, whose source is this tabbedpane, to
each listener. This method method is called each time
a ChangeEvent is received from the model.
- See Also:
- addChangeListener, EventListenerList
getModel
public SingleSelectionModel getModel()
- Returns the model associated with this tabbedpane.
- See Also:
- setModel
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
getTabPlacement
public int getTabPlacement()
- Returns the placement of the tabs for this tabbedpane.
- See Also:
- setPlacement
setTabPlacement
public void setTabPlacement(int tabPlacement)
- Sets the tab placement for this tabbedpane to be either
TOP, LEFT, BOTTOM, or RIGHT.
- Parameters:
- tabPlacement - the placement for the tabs relative to the content
- See Also:
- getPlacement
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
setSelectedIndex
public void setSelectedIndex(int index)
- Sets the selected index for this tabbedpane.
- See Also:
- getSelectedIndex, setSelectedIndex
getSelectedComponent
public Component 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
setSelectedComponent
public void setSelectedComponent(Component 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
insertTab
public void insertTab(String title,
Icon icon,
Component 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.Vector 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, removeTabAt
addTab
public void addTab(String title,
Icon icon,
Component 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, removeTabAt
addTab
public void addTab(String title,
Icon icon,
Component 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, removeTabAt
addTab
public void addTab(String title,
Component 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, removeTabAt
removeTabAt
public void removeTabAt(int index)
- Removes the tab at index.
- Parameters:
- index - the index of the tab to be removed
- See Also:
- addTab, removeTabAt
getTabCount
public int getTabCount()
- Returns the number of tabs in this tabbedpane.
getTabRunCount
public int getTabRunCount()
- Returns the number of tab runs currently used to display
the tabs. This returns the number of rows if the tabPlacement
is TOP or BOTTOM and the number of columns if tabPlacement
is LEFT or RIGHT.
If there is no UI set on this tabbedpane, then returns 0.
getTitleAt
public String getTitleAt(int index)
- Returns the tab title at index.
- See Also:
- setTitleAt
getIconAt
public Icon getIconAt(int index)
- Returns the tab icon at index.
- See Also:
- setIconAt
getDisabledIconAt
public Icon getDisabledIconAt(int index)
- Returns the tab disabled icon at index.
- See Also:
- setDisabledIconAt
getBackgroundAt
public Color getBackgroundAt(int index)
- Returns the tab background color at index.
- See Also:
- setBackgroundAt
getForegroundAt
public Color getForegroundAt(int index)
- Returns the tab foreground color at index.
- See Also:
- setForegroundAt
isEnabledAt
public boolean isEnabledAt(int index)
- Returns whether or not the tab at index is
currently enabled.
- See Also:
- setEnabledAt
getComponentAt
public Component getComponentAt(int index)
- Returns the component at index.
- See Also:
- setComponentAt
getBoundsAt
public Rectangle getBoundsAt(int index)
- Returns the tab bounds at index.
If there is no UI set on this tabbedpane, then returns null.
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
setIconAt
public void setIconAt(int index,
Icon 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
setDisabledIconAt
public void setDisabledIconAt(int index,
Icon 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
- icon - the icon to be displayed in the tab when disabled
- See Also:
- getDisabledIconAt
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
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
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
setComponentAt
public void setComponentAt(int index,
Component 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:
- getComponentAt
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(Icon 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
indexOfComponent
public int indexOfComponent(Component 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
getToolTipText
public String getToolTipText(MouseEvent event)
- Returns the string to be used as the tooltip for event.
- Overrides:
- getToolTipText in class JComponent
getAccessibleContext
public AccessibleContext getAccessibleContext()
- Get the AccessibleContext associated with this JComponent
- Returns:
- the AccessibleContext of this JComponent
- Overrides:
- getAccessibleContext in class JComponent
All Packages Class Hierarchy This Package Previous Next Index
changeEvent
JTabbedPane()
addChangeListener(ChangeListener)