net.infonode.tabbedpanel
public class Tab extends JPanel
A Tab is a component that represents a tab in a TabbedPanel.
A tab can hold a content component. The content component will then be shown in the content area of the TabbedPanel that the tab is a member of when the tab is selected. If the tab doesn't have a content component, then the TabbedPanel will not show any content in the content area, i.e. it will be empty.
The tab is basically a JPanel with a BorderLayout. The layout manager can be changed using setLayout. Components and borders can be added and removed from the tab. The tab can also be subclassed to create other types of tabs, see TitledTab. In most cases TitledTab is the preferred tab type to use because TitledTab adds support for a text, icon, looks etc.
The tab component will be shown in the tab area of a TabbedPanel after the tab has become a member of that TabbedPanel by either adding or inserting it. A tab can only be a member of one TabbedPanel at the same time.
A tab can have different states when it is a member of a TabbedPanel:
Version: $Revision: 1.33 $
See Also: TabListener TabbedPanel TitledTab
Constructor Summary | |
---|---|
Tab()
Constructs a tab without a content component and this tab as event
component
| |
Tab(JComponent contentComponent)
Constructs a tab with a content component and this tab as event
component
|
Method Summary | |
---|---|
void | addNotify() |
void | addTabListener(TabListener listener)
Adds a TabListener
|
JComponent | getContentComponent()
Gets the content component
|
JComponent[] | getEventComponents()
Gets the event components for this Tab
|
JComponent | getFocusableComponent()
Gets the component in this tab that is focusable
|
int | getIndex()
Gets the index of this tab in the TabbedPanel.
|
Shape | getShape() Gets the tab Shape. This returns the shape of the tab. |
TabbedPanel | getTabbedPanel()
Gets the TabbedPanel that this tab is a member of
|
boolean | isHighlighted()
Returns if this tab is highlighted in the TabbedPanel that it is a member of.
|
boolean | isSelected()
Returns if this tab is selected in the TabbedPanel that it is a member of.
|
void | removeNotify() |
void | removeTabListener(TabListener listener)
Removes a TabListener
|
void | setEnabled(boolean enabled) Enable or disable this tab. If the tab is disabled, then the tab will not signal any events until it is enabled again. |
void | setEventComponent(JComponent eventComponent) Sets the event component. |
void | setEventComponents(JComponent[] eventComponents) Sets a list of event components. |
void | setFocusableComponent(JComponent focusableComponent) Sets the component in this tab that represents the focusable part of the tab. Note: The focusable component must be part of this Tab |
void | setHighlighted(boolean highlighted)
Highlights this tab. |
void | setSelected(boolean selected) Selects this tab. |
protected void | setTabbedPanel(TabbedPanel tabbedPanel)
Called by the tabbed panel when the tab becomes a member or is no longer a member of the
tabbed panel
|
See Also: Tab
Parameters: contentComponent content component for this tab or null for no content component.
See Also: Tab
Parameters: listener the TabListener to add
Returns: the content component for this tab or null if this Tab doesn't have a content component
Returns: a list of all event components for this tab
Returns: focusable component or null if this tab doesn't have any focusable component
Returns: the tab index, -1 if this tab is not a member of a TabbedPanel.
Gets the tab Shape.
This returns the shape of the tab. This can be be used by for example content borders in the tabbed panel so they can skip a gap where the tab intersects the tabbed panel content area.
Returns: the tab Shape, null if the tab has the normal component rectangle shape
Since: ITP 1.2.0
Returns: the TabbedPanel or null if this tab is not a member of any TabbedPanel
Returns: true if highlighted, false if not highlighted or this tab is not member of a TabbedPanel
Returns: true if selected, false if not selected or this tab is not member of a TabbedPanel
Parameters: listener the TabListener to remove
Enable or disable this tab.
If the tab is disabled, then the tab will not signal any events until it is enabled again.
Parameters: enabled true for enabled, otherwise false
Sets the event component. An event component is a component in the tab that is used for internal listening to mouse events on the tab.
Note: The event component must be part of this Tab
Parameters: eventComponent a component in this tab that should be used for mouse event listening
Sets a list of event components. An event component is a component in the tab that is used for internal listening to mouse events on the tab. This method makes it possible to use several components in the tab as event components.
Note: The event components must be part of this Tab
Parameters: eventComponents a list of components in this tab that should be used for mouse event listening
Sets the component in this tab that represents the focusable part of the tab.
Note: The focusable component must be part of this Tab
Parameters: focusableComponent a component in this tab or null if no component should be focusable
Parameters: highlighted true for highlight, otherwise false
Selects this tab. A tab can only have the selected state if it is a member of a TabbedPanel.
Setting selected to true means that this tab will be the selected tab in the TabbedPanel it is a member of. If this tab is the selected tab in the TabbedPanel then setting selected to false means there will be no selected tab in the TabbedPanel until another tab is selected.
Parameters: selected True for selected, otherwise false
Parameters: tabbedPanel tabbed panel that this tab is a member of or null if this tab is no longer a member o a tabbed panel