|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JTabbedPane
A component which lets the user switch between a group of components by clicking on a tab with a given title and/or icon.
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.
See How to Use Tabbed Panes in The Java Tutorial for further documentation.
For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JTabbedPane key assignments.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
SingleSelectionModel
, Serialized FormInner Class Summary | |
protected class |
JTabbedPane.AccessibleJTabbedPane
The class used to obtain the accessible role for this object. |
protected class |
JTabbedPane.ModelListener
We pass ModelChanged events along to the listeners with the tabbedpane (instead of the model itself) as the event source. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary | |
protected ChangeEvent |
changeEvent
Only one ChangeEvent is needed per TabPane instance since the event's only (read-only) state is the source property. |
protected ChangeListener |
changeListener
The changeListener is the listener we add to the model. |
protected SingleSelectionModel |
model
The default selection model |
protected int |
tabPlacement
Where the tabs are placed. |
Fields inherited from class javax.swing.JComponent |
accessibleContext,
listenerList,
TOOL_TIP_TEXT_KEY,
ui,
UNDEFINED_CONDITION,
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,
WHEN_FOCUSED,
WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT,
CENTER_ALIGNMENT,
LEFT_ALIGNMENT,
RIGHT_ALIGNMENT,
TOP_ALIGNMENT |
Fields inherited from interface javax.swing.SwingConstants |
BOTTOM,
CENTER,
EAST,
HORIZONTAL,
LEADING,
LEFT,
NORTH,
NORTH_EAST,
NORTH_WEST,
RIGHT,
SOUTH,
SOUTH_EAST,
SOUTH_WEST,
TOP,
TRAILING,
VERTICAL,
WEST |
Constructor Summary | |
JTabbedPane()
Creates an empty TabbedPane. |
|
JTabbedPane(int tabPlacement)
Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT. |
Method Summary | |
Component |
add(Component component)
Adds a component with a tab title defaulting to the name of the component. |
Component |
add(Component component,
int index)
Adds a component at the specified tab index with a tab title defaulting to the name of the component. |
void |
add(Component component,
Object constraints)
Adds a component to the tabbed pane. |
void |
add(Component component,
Object constraints,
int index)
Adds a component at the specified tab index. |
Component |
add(String title,
Component component)
Adds a component with the specified tab title. |
void |
addChangeListener(ChangeListener l)
Adds a ChangeListener to this tabbedpane. |
void |
addTab(String title,
Component component)
Adds a component represented by a title and no icon. |
void |
addTab(String title,
Icon icon,
Component component)
Adds a component represented by a title and/or icon, either of which can be null. |
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. |
protected ChangeListener |
createChangeListener()
Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation. |
protected void |
fireStateChanged()
Send a ChangeEvent, whose source is this tabbedpane, to each listener. |
AccessibleContext |
getAccessibleContext()
Get the AccessibleContext associated with this JComponent |
Color |
getBackgroundAt(int index)
Returns the tab background color at index. |
Rectangle |
getBoundsAt(int index)
Returns the tab bounds at index. |
Component |
getComponentAt(int index)
Returns the component at index. |
Icon |
getDisabledIconAt(int index)
Returns the tab disabled icon at index. |
Color |
getForegroundAt(int index)
Returns the tab foreground color at index. |
Icon |
getIconAt(int index)
Returns the tab icon at index. |
SingleSelectionModel |
getModel()
Returns the model associated with this tabbedpane. |
Component |
getSelectedComponent()
Returns the currently selected component for this tabbedpane. |
int |
getSelectedIndex()
Returns the currently selected index for this tabbedpane. |
int |
getTabCount()
Returns the number of tabs in this tabbedpane. |
int |
getTabPlacement()
Returns the placement of the tabs for this tabbedpane. |
int |
getTabRunCount()
Returns the number of tab runs currently used to display the tabs. |
String |
getTitleAt(int index)
Returns the tab title at index. |
String |
getToolTipText(MouseEvent event)
Returns the tooltip text for the component determined by the mouse event location. |
TabbedPaneUI |
getUI()
Returns the UI object which implements the L&F for this component. |
String |
getUIClassID()
Returns the name of the UI class that implements the L&F for this component. |
int |
indexOfComponent(Component component)
Returns the index of the tab for the specified component. |
int |
indexOfTab(Icon 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,
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. |
boolean |
isEnabledAt(int index)
Returns whether or not the tab at index is currently enabled. |
protected String |
paramString()
Returns a string representation of this JTabbedPane. |
void |
remove(Component component)
Removes the tab which corresponds to the specified component. |
void |
removeAll()
Removes all the tabs from the tabbedpane. |
void |
removeChangeListener(ChangeListener l)
Removes a ChangeListener from this tabbedpane. |
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 |
setComponentAt(int index,
Component component)
Sets the component at index to component. |
void |
setDisabledIconAt(int index,
Icon 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 |
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,
Icon icon)
Sets the icon at index to icon which can be null. |
void |
setModel(SingleSelectionModel model)
Sets the model to be used with this tabbedpane. |
void |
setSelectedComponent(Component c)
Sets the selected component for this tabbedpane. |
void |
setSelectedIndex(int index)
Sets the selected index for 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 |
setUI(TabbedPaneUI ui)
Sets the UI object which implements the L&F for this component. |
void |
updateUI()
Notification from the UIManager that the L&F has changed. |
Methods inherited from class java.awt.Container |
addContainerListener,
addImpl,
countComponents,
deliverEvent,
doLayout,
findComponentAt,
findComponentAt,
getComponent,
getComponentAt,
getComponentAt,
getComponentCount,
getComponents,
getLayout,
insets,
invalidate,
isAncestorOf,
layout,
list,
list,
locate,
minimumSize,
paintComponents,
preferredSize,
print,
printComponents,
processContainerEvent,
processEvent,
remove,
removeContainerListener,
setCursor,
setLayout,
validate,
validateTree |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected int tabPlacement
setTabPlacement(int)
protected SingleSelectionModel model
protected ChangeListener changeListener
protected transient ChangeEvent changeEvent
Constructor Detail |
public JTabbedPane()
public JTabbedPane(int tabPlacement)
tabPlacement
- the placement for the tabs relative to the contentaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
Method Detail |
public TabbedPaneUI getUI()
setUI(javax.swing.plaf.TabbedPaneUI)
public void setUI(TabbedPaneUI ui)
ui
- the new UI objectUIDefaults.getUI(javax.swing.JComponent)
public void updateUI()
JComponent.updateUI()
public String getUIClassID()
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
protected ChangeListener createChangeListener()
fireStateChanged()
public void addChangeListener(ChangeListener l)
l
- the ChangeListener to addfireStateChanged()
,
removeChangeListener(javax.swing.event.ChangeListener)
public void removeChangeListener(ChangeListener l)
l
- the ChangeListener to removefireStateChanged()
,
addChangeListener(javax.swing.event.ChangeListener)
protected void fireStateChanged()
public SingleSelectionModel getModel()
public void setModel(SingleSelectionModel model)
model
- the model to be usedgetModel()
public int getTabPlacement()
setTabPlacement(int)
public void setTabPlacement(int tabPlacement)
tabPlacement
- the placement for the tabs relative to the contentpublic int getSelectedIndex()
setSelectedIndex(int)
public void setSelectedIndex(int index)
public Component getSelectedComponent()
setSelectedComponent(java.awt.Component)
public void setSelectedComponent(Component c)
getSelectedComponent()
public void insertTab(String title, Icon icon, Component component, String tip, int index)
title
- the title to be displayed in this tabicon
- the icon to be displayed in this tabcomponent
- The component to be displayed when this tab is clicked.tip
- the tooltip to be displayed for this tabindex
- the position to insert this new tabaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
public void addTab(String title, Icon icon, Component component, String tip)
title
- the title to be displayed in this tabicon
- the icon to be displayed in this tabcomponent
- The component to be displayed when this tab is clicked.tip
- the tooltip to be displayed for this tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void addTab(String title, Icon icon, Component component)
title
- the title to be displayed in this tabicon
- the icon to be displayed in this tabcomponent
- The component to be displayed when this tab is clicked.insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void addTab(String title, Component component)
title
- the title to be displayed in this tabcomponent
- The component to be displayed when this tab is clicked.insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(Component component)
component
- The component to be displayed when this tab is clicked.insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(String title, Component component)
title
- the title to be displayed in this tabcomponent
- The component to be displayed when this tab is clicked.insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(Component component, int index)
component
- The component to be displayed when this tab is clicked.index
- the position to insert this new tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void add(Component component, Object constraints)
component
- The component to be displayed when this tab is clicked.insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void add(Component component, Object constraints, int index)
component
- The component to be displayed when this tab is clicked.index
- the position to insert this new tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void removeTabAt(int index)
index
- the index of the tab to be removedaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
public void remove(Component component)
component
- the component to remove from the tabbedpaneaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
public void removeAll()
public int getTabCount()
public int getTabRunCount()
public String getTitleAt(int index)
setTitleAt(int, java.lang.String)
public Icon getIconAt(int index)
setIconAt(int, javax.swing.Icon)
public Icon getDisabledIconAt(int index)
setDisabledIconAt(int, javax.swing.Icon)
public Color getBackgroundAt(int index)
setBackgroundAt(int, java.awt.Color)
public Color getForegroundAt(int index)
setForegroundAt(int, java.awt.Color)
public boolean isEnabledAt(int index)
setEnabledAt(int, boolean)
public Component getComponentAt(int index)
setComponentAt(int, java.awt.Component)
public Rectangle getBoundsAt(int index)
public void setTitleAt(int index, String title)
index
- the tab index where the title should be settitle
- the title to be displayed in the tabgetTitleAt(int)
public void setIconAt(int index, Icon icon)
index
- the tab index where the icon should be seticon
- the icon to be displayed in the tabgetIconAt(int)
public void setDisabledIconAt(int index, Icon disabledIcon)
index
- the tab index where the disabled icon should be seticon
- the icon to be displayed in the tab when disabledgetDisabledIconAt(int)
public void setBackgroundAt(int index, Color background)
index
- the tab index where the background should be setbackground
- the color to be displayed in the tab's backgroundgetBackgroundAt(int)
public void setForegroundAt(int index, Color foreground)
index
- the tab index where the foreground should be setforeground
- the color to be displayed as the tab's foregroundgetForegroundAt(int)
public void setEnabledAt(int index, boolean enabled)
index
- the tab index which should be enabled/disabledenabled
- whether or not the tab should be enabledisEnabledAt(int)
public void setComponentAt(int index, Component component)
index
- the tab index where this component is being placedcomponent
- the component for the tabgetComponentAt(int)
public int indexOfTab(String title)
title
- the title for the tabpublic int indexOfTab(Icon icon)
icon
- the icon for the tabpublic int indexOfComponent(Component component)
component
- the component for the tabpublic String getToolTipText(MouseEvent event)
event
- the MouseEvent that tells where the cursor is lingeringprotected String paramString()
null
.public AccessibleContext getAccessibleContext()
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |