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

java.lang.Object
  bibliothek.extension.gui.dock.theme.eclipse.stack.tab.DockTitleTab

All Implemented Interfaces:

TabComponent, DockElementRepresentative

public class DockTitleTab
extends java.lang.Object
implements TabComponent

A DockTitleTab is a wrapper around an ordinary DockTitle to get a TabComponent.
This DockTitleTab will use EclipseDockTitleEvents to inform its DockTitle when a property has changed, the method DockTitle.changed(bibliothek.gui.dock.event.DockTitleEvent) is called for that purpose.

Author:

Benjamin Sigg

Field Summary

static TabPainter

FACTORY A TabPainter that uses the id EclipseTheme.TAB_DOCK_TITLE to get a DockTitleVersion from the DockTitleManager and create a new DockTitle which is then wrapped by a DockTitleTab.

Constructor Summary

DockTitleTab(DockStation station, Dockable dockable, DockTitleVersion title)
Creates a new tab.

Method Summary

void	addMouseInputListener(javax.swing.event.MouseInputListener listener) Adds a listener to this representative, it is not defined what to do with that listener, but most subclasses would just add the listener to their component.
void	addMouseListener(java.awt.event.MouseListener listener)
void	addMouseMotionListener(java.awt.event.MouseMotionListener listener)
void	bind() Informs this tab that it will be shown soon
static TabPainter	createFactory(TabPainter fallback) Creates a new factory which uses fallback to create a TabComponent when no DockTitle is available.
protected void	fire() Fires an event to the DockTitle of this DockTitleTab.
java.awt.Component	getComponent() Gets the internal representation of this TabComponent, this method must always return the same value.
DockElement	getElement() Gets the element which is represented by this.
java.awt.Dimension	getMinimumSize(TabComponent[] tabs) Gets the minimum size of this tab under the assumption that this tab is displayed together with tabs.
java.awt.Insets	getOverlap(TabComponent other) Gets the number of pixels which should be covered at the sides of this component by other tabs.
java.awt.Point	getPopupLocation(java.awt.Point click, boolean popupTrigger) Tells whether a popup menu should be opened when the user clicks at click with the mouse.
java.awt.Dimension	getPreferredSize(TabComponent[] tabs) Gets the preferred size of this tab under the assumption that this tab is displayed together with tabs.
boolean	isUsedAsTitle() Tells whether this DockElementRepresentative is used as title.
void	removeMouseInputListener(javax.swing.event.MouseInputListener listener) Removes a listener from this representative.
void	removeMouseListener(java.awt.event.MouseListener listener)
void	removeMouseMotionListener(java.awt.event.MouseMotionListener listener)
void	setFocused(boolean focused) Tells this component that its Dockable gained or lost focus.
void	setIcon(javax.swing.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(java.lang.String text) Sets the text that should be displayed on this tab.
void	setTooltip(java.lang.String tooltip) Sets the tooltip that should be displayed on this tab.
boolean	shouldFocus() Tells whether a click onto this component should transfer the focus either to this component or to the Dockable.
boolean	shouldTransfersFocus() Tells whether a click onto this component should transfer the focus to the Dockable or not.
void	unbind() Informs this tab that it is invisible and must not have any connections to other resources
void	update() Updates the selection and focus state of the title of this tab.

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final TabPainter FACTORY

A TabPainter that uses the id EclipseTheme.TAB_DOCK_TITLE to get a DockTitleVersion from the DockTitleManager and create a new DockTitle which is then wrapped by a DockTitleTab.

Constructor Detail

DockTitleTab

public DockTitleTab(DockStation station,
                    Dockable dockable,
                    DockTitleVersion title)

Creates a new tab.

Parameters:

station - the station which uses the tabbed pane, might be null

dockable - the element for which this tab is shown

title - the title which represents the tab

Method Detail

createFactory

public static final TabPainter createFactory(TabPainter fallback)

Creates a new factory which uses fallback to create a TabComponent when no DockTitle is available.

Parameters:

fallback - the backup-factory

Returns:

a new TabPainter

setOrientation

public void setOrientation(TabPlacement orientation)

Description copied from interface: TabComponent

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

Specified by:

setOrientation in interface TabComponent

Parameters:

orientation - the orientation, not null

setTab

public void setTab(EclipseTab tab)

Description copied from interface: TabComponent

Informs this TabComponent by which tab is is used.

Specified by:

setTab in interface TabComponent

Parameters:

tab - the owner of this TabComponent

bind

public void bind()

Description copied from interface: TabComponent

Informs this tab that it will be shown soon

Specified by:

bind in interface TabComponent

unbind

public void unbind()

Description copied from interface: TabComponent

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

Specified by:

unbind in interface TabComponent

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener listener)

getComponent

public java.awt.Component getComponent()

Description copied from interface: TabComponent

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

Specified by:

getComponent in interface TabComponent

Specified by:

getComponent in interface DockElementRepresentative

Returns:

the internal representation, not null

getMinimumSize

public java.awt.Dimension getMinimumSize(TabComponent[] tabs)

Description copied from interface: TabComponent

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

Specified by:

getMinimumSize in interface TabComponent

Parameters:

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

Returns:

the minimum size of this tab

getPreferredSize

public java.awt.Dimension getPreferredSize(TabComponent[] tabs)

Description copied from interface: TabComponent

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

Specified by:

getPreferredSize in interface TabComponent

Parameters:

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

Returns:

the preferred size of this tab

getElement

public DockElement getElement()

Description copied from interface: DockElementRepresentative

Gets the element which is represented by this. The result of this method must not change.

Specified by:

getElement in interface DockElementRepresentative

Returns:

the element, never null

isUsedAsTitle

public boolean isUsedAsTitle()

Description copied from interface: DockElementRepresentative

Tells whether this DockElementRepresentative is used as title.
Some modules grant more rights to titles than to non-titles, i.e. a DockRelocator can allow drag & drop only for titles.
Normally a Dockable should have only one element that is a title, so if in doubt return false.

Specified by:

isUsedAsTitle in interface DockElementRepresentative

Returns:

true if this representative should be seen as title

shouldTransfersFocus

public boolean shouldTransfersFocus()

Description copied from interface: DockElementRepresentative

Tells whether a click onto this component should transfer the focus to the Dockable or not. If this object is a Dockable, then a result of true might change the currently focused item of itself. This property is ignored if DockElementRepresentative.shouldFocus() returns false.

Specified by:

shouldTransfersFocus in interface DockElementRepresentative

Returns:

whether to change the focused component or not

shouldFocus

public boolean shouldFocus()

Description copied from interface: DockElementRepresentative

Tells whether a click onto this component should transfer the focus either to this component or to the Dockable.

Specified by:

shouldFocus in interface DockElementRepresentative

Returns:

true if clicking this component should influence focus

getPopupLocation

public java.awt.Point getPopupLocation(java.awt.Point click,
                                       boolean popupTrigger)

Description copied from interface: DockElementRepresentative

Tells whether a popup menu should be opened when the user clicks at click with the mouse. If yes, then the top left edge of the popup should be returned, otherwise null should be returned.

Specified by:

getPopupLocation in interface DockElementRepresentative

Parameters:

click - the location where the user clicked with the mouse

popupTrigger - whether the invocation is the systems popup trigger or not. Many implementations of this method will return click in case of true, and null in case of false

Returns:

the preferred location of a popup or null if no popup-menu should be opened

addMouseInputListener

public void addMouseInputListener(javax.swing.event.MouseInputListener listener)

Description copied from interface: DockElementRepresentative

Adds a listener to this representative, it is not defined what to do with that listener, but most subclasses would just add the listener to their component. It is valid to do nothing.

Specified by:

addMouseInputListener in interface DockElementRepresentative

Parameters:

listener - the new listener

removeMouseInputListener

public void removeMouseInputListener(javax.swing.event.MouseInputListener listener)

Description copied from interface: DockElementRepresentative

Removes a listener from this representative.

Specified by:

removeMouseInputListener in interface DockElementRepresentative

Parameters:

listener - the listener to remove

getOverlap

public java.awt.Insets getOverlap(TabComponent other)

Description copied from interface: TabComponent

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

Specified by:

getOverlap in interface TabComponent

Parameters:

other - the component which may overlap this component

Returns:

the number of overlapped pixels

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener listener)

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener listener)

setFocused

public void setFocused(boolean focused)

Description copied from interface: TabComponent

Tells this component that its Dockable gained or lost focus.

Specified by:

setFocused in interface TabComponent

Parameters:

focused - the state of its dockable.

setPaintIconWhenInactive

public void setPaintIconWhenInactive(boolean paint)

Description copied from interface: TabComponent

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

Specified by:

setPaintIconWhenInactive in interface TabComponent

Parameters:

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

setSelected

public void setSelected(boolean selected)

Description copied from interface: TabComponent

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

Specified by:

setSelected in interface TabComponent

Parameters:

selected - the selection state of this tab

setIcon

public void setIcon(javax.swing.Icon icon)

Description copied from interface: TabComponent

Sets the icon that should be painted on this tab.

Specified by:

setIcon in interface TabComponent

Parameters:

icon - the icon, can be null

setText

public void setText(java.lang.String text)

Description copied from interface: TabComponent

Sets the text that should be displayed on this tab.

Specified by:

setText in interface TabComponent

Parameters:

text - the new text

setTooltip

public void setTooltip(java.lang.String tooltip)

Description copied from interface: TabComponent

Sets the tooltip that should be displayed on this tab.

Specified by:

setTooltip in interface TabComponent

Parameters:

tooltip - the new tooltip, can be null

update

public void update()

Updates the selection and focus state of the title of this tab.

fire

protected void fire()

Fires an event to the DockTitle of this DockTitleTab.