bibliothek.extension.gui.dock.theme.eclipse.stack.tab

Interface TabComponent

All Superinterfaces:

DockElementRepresentative

All Known Implementing Classes:

ArchGradientPainter, BaseTabComponent, DockTitleTab, RectGradientPainter

public interface TabComponent
extends DockElementRepresentative

A TabComponent paints the content of an EclipseTab. This component is informed about the change of properties that are often needed to paint properly.

Method Summary

Modifier and Type	Method and Description
void	bind() Informs this tab that it will be shown soon
Component	getComponent() Gets the internal representation of this TabComponent, this method must always return the same value.
EclipseTabStateInfo	getEclipseTabStateInfo() Gets information about the state of this tab.
Dimension	getMinimumSize(TabComponent[] tabs) Gets the minimum size of this tab under the assumption that this tab is displayed together with tabs.
Insets	getOverlap(TabComponent other) Gets the number of pixels which should be covered at the sides of this component by other tabs.
Dimension	getPreferredSize(TabComponent[] tabs) Gets the preferred size of this tab under the assumption that this tab is displayed together with tabs.
void	setConfiguration(TabConfiguration configuration) Fine tunes the look and behavior of this tab.
void	setEnabled(boolean enabled) Enables or disables this component.
void	setFocused(boolean focused) Tells this component that its Dockable gained or lost focus.
void	setIcon(Icon icon) Sets the icon that should be painted on this tab.
void	setOrientation(TabPlacement orientation) Sets the placement of the tabs and as a result the orientation of this component.
void	setPaintIconWhenInactive(boolean paint) Tells this component whether to paint an Icon if not selected.
void	setSelected(boolean selected) Tells this component whether it has to be painted selected or not.
void	setTab(EclipseTab tab) Informs this TabComponent by which tab is is used.
void	setText(String text) Sets the text that should be displayed on this tab.
void	setTooltip(String tooltip) Sets the tooltip that should be displayed on this tab.
void	unbind() Informs this tab that it is invisible and must not have any connections to other resources

Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative

addMouseInputListener, getElement, getPopupLocation, isUsedAsTitle, removeMouseInputListener, shouldFocus, shouldTransfersFocus

Method Detail

getComponent

Component getComponent()

Gets the internal representation of this TabComponent, this method must always return the same value.

Specified by:

getComponent in interface DockElementRepresentative

Returns:

the internal representation, not null

getEclipseTabStateInfo

EclipseTabStateInfo getEclipseTabStateInfo()

Gets information about the state of this tab.

Returns:

information about the state, updates itself.

setSelected

void setSelected(boolean selected)

Tells this component whether it has to be painted selected or not.

Parameters:

selected - the selection state of this tab

setFocused

void setFocused(boolean focused)

Tells this component that its Dockable gained or lost focus.

Parameters:

focused - the state of its dockable.

setEnabled

void setEnabled(boolean enabled)

Enables or disables this component. A disabled component should be visually distinct from an enabled one. Note that EclipseTab automatically removes all MouseInputListeners from a TabComponent that is not enabled.

Parameters:

enabled - whether this component is enabled or not

setPaintIconWhenInactive

void setPaintIconWhenInactive(boolean paint)

Tells this component whether to paint an Icon if not selected.

Parameters:

paint - true if an icon is always to be painted, false if icons should only appear on selected tabs.

setOrientation

void setOrientation(TabPlacement orientation)

Sets the placement of the tabs and as a result the orientation of this component.

Parameters:

orientation - the orientation, not null

setTab

void setTab(EclipseTab tab)

Informs this TabComponent by which tab is is used.

Parameters:

tab - the owner of this TabComponent

setConfiguration

void setConfiguration(TabConfiguration configuration)

Fine tunes the look and behavior of this tab.

Parameters:

configuration - the new configuration to use, not null

getOverlap

Insets getOverlap(TabComponent other)

Gets the number of pixels which should be covered at the sides of this component by other tabs.

Parameters:

other - the component which may overlap this component

Returns:

the number of overlapped pixels

bind

void bind()

Informs this tab that it will be shown soon

unbind

void unbind()

Informs this tab that it is invisible and must not have any connections to other resources

getMinimumSize

Dimension getMinimumSize(TabComponent[] tabs)

Gets the minimum size of this tab under the assumption that this tab is displayed together with tabs.

Parameters:

tabs - the displayed tabs, exactly one entry is this and may contain null entries.

Returns:

the minimum size of this tab

getPreferredSize

Dimension getPreferredSize(TabComponent[] tabs)

Gets the preferred size of this tab under the assumption that this tab is displayed together with tabs.

Parameters:

tabs - the displayed tabs, exactly one entry is this and may contain null entries.

Returns:

the preferred size of this tab

setText

void setText(String text)

Sets the text that should be displayed on this tab.

Parameters:

text - the new text

setTooltip

void setTooltip(String tooltip)

Sets the tooltip that should be displayed on this tab.

Parameters:

tooltip - the new tooltip, can be null

setIcon

void setIcon(Icon icon)

Sets the icon that should be painted on this tab.

Parameters:

icon - the icon, can be null