bibliothek.gui.dock.station.stack
Class CombinedStackDockComponent<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

java.lang.Object
  bibliothek.gui.dock.station.stack.tab.AbstractTabPane<T,M,I>
      bibliothek.gui.dock.station.stack.CombinedStackDockComponent<T,M,I>

Type Parameters:

T - the type of the tabs

M - the type of the menus

I - the type of the additinal info panel

All Implemented Interfaces:

StackDockComponent, TabPane

Direct Known Subclasses:

BubbleStackDockComponent, EclipseTabPane, FlatTabPane

public abstract class CombinedStackDockComponent<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>
extends AbstractTabPane<T,M,I>
implements StackDockComponent

A StackDockComponent which is a combination of other components.
This class also implements TabPane and thus supports the TabLayoutManager.

Author:

Benjamin Sigg

Nested Class Summary

protected class

CombinedStackDockComponent.Meta Meta information about a Dockable that is shown on this CombinedStackDockComponent.

Field Summary

Fields inherited from interface bibliothek.gui.dock.station.stack.tab.TabPane

LAYOUT_MANAGER, USE_SMALL_MINIMUM_SIZE

Constructor Summary

CombinedStackDockComponent()
Constructs a new component.

Method Summary

void	addStackDockComponentListener(StackDockComponentListener listener) Adds a listener to this component, it will be called if the selection changes.
void	addTab(String title, Icon icon, Component comp, Dockable dockable) Adds a new child at an unspecified location.
protected void	addToMenu(M menu, Dockable dockable) Adds dockable somewhere to menu
protected void	clearTabs() Removes all tabs from the internal data structure. Subclasses may override this method to be informed about the exact time when a tab changes, but the overriden method must call the original method.
protected BackgroundAlgorithm	createBackground(CombinedStackDockComponent<T,M,I> self) Creates the background algorithm that is used for this component.
protected BorderForwarder	createContentBorderModifier(Dockable dockable, JComponent component) Creates a BorderForwarder for the content component for the tab of dockable
protected CombinedStackDockContentPane	createContentPane(CombinedStackDockComponent<T,M,I> self) Creates the content pane for this component.
DockElementRepresentative	createDefaultRepresentation(DockElement target) Creates and returns a new DockElementRepresentative representing target, the new representation is to be used to cover all the empty areas on this StackDockComponent.
protected Component	createLayerAt(Component component, Dockable dockable) Creates a layer between component and this panel.
protected void	fireTabChanged(Dockable dockable) Calls StackDockComponentListener.tabChanged(StackDockComponent, Dockable) on all listeners that are currently registered.
Rectangle	getAvailableArea() Gets the area in which all the Tabs, TabMenus and the visible Dockable (TabPane.setSelectedBounds(Rectangle)) must find their place.
Rectangle	getBoundsAt(int index) Gets the location and size of the graphical element that allows the user to select the index'th child.
JComponent	getComponent() Gets a Component on which the children of this StackDockComponent will be displayed.
TabConfiguration	getConfiguration(Dockable child) Forwards child to the current TabConfigurations, in order to get the matching TabConfiguration.
protected CombinedStackDockComponent.Meta	getContentAt(int index) Gets the meta information about the components at location index
Dockable	getDockableAt(int index) Gets the Dockable which was placed at the index'th position.
int	getIndexOfTabAt(Point mouseLocation) Gets the index of the tab that is beneath mouseLocation.
CombinedHandler<AbstractTabPaneComponent>	getInfoHandler() Gets a handler for info components.
Component	getLayerAt(int index) Gets the index'th Component on this tab.
CombinedHandler<CombinedMenu>	getMenuHandler() Gets a handler for menus.
Dimension	getMinimumSize() Gets the minimal size required to have a big enough TabPane.getAvailableArea() to show all content.
Dimension	getMinimumSize(Dockable dockable) Gets the minimum size that is required to show the child dockable.
T	getOnTab(Dockable dockable) Gets the tab-button for dockable, if no tab-button for dockable exists a new button should be created.
Dimension	getPreferredSize() Gets the preferred size required to have a big enough TabPane.getAvailableArea() to show all content.
Dimension	getPreferredSize(Dockable dockable) Gets the preferred size that is required to show the child dockable.
Rectangle	getSelectedBounds() Gets the boundaries the selected Dockable has (independent of whether such a Dockable exists).
int	getSelectedIndex() Gets the index of the currently selected dockable
DockElementRepresentative	getTabAt(int index) Gets an element representing the tab of the Dockable at index.
int	getTabCount() Gets the number of children that are added to this StackDockComponent.
CombinedHandler<CombinedTab>	getTabHandler() Gets a handler for tabs.
protected int	getZOrder(Component component) Gets the z order of component.
void	insertTab(String title, Icon icon, Component comp, Dockable dockable, int index) Adds a new child at the location index.
void	moveTab(int source, int destination) Moves the tab at source to location destination.
T	putOnTab(Dockable dockable) Informs this pane that its child dockable should have a tab-button.
protected T	putTab(Dockable dockable, T tab) Associates tab with dockable.
void	remove(int index) Removes the index'th element of this pane.
void	removeAll() Removes all elements from this pane.
protected void	removeFromMenu(M menu, Dockable dockable) Removes dockable from menu.
void	removeStackDockComponentListener(StackDockComponentListener listener) Removes listener from this component.
protected T	removeTab(Dockable dockable) Removes the tab of dockable from the internal data structure.
void	repaint() Repaints the contents of this component.
void	revalidate() Called when the layout of this pane has become invalid, the default behavior is to call AbstractTabPane.doLayout().
void	setComponentAt(int index, Component component) Sets the component which should be shown at tab index.
void	setController(DockController controller) Connects this pane with controller.
protected void	setEnabledAt(Dockable dockable, boolean enabled) Changes the enabled state of the item dockable.
void	setIconAt(int index, Icon newIcon) Sets the icon of the child at location index.
void	setSelectedBounds(Rectangle bounds) Sets the boundaries of the selected Dockable.
void	setSelectedDockable(Dockable dockable) Selects the child dockable of this pane as the one visible element.
void	setSelectedIndex(int index) Selects the component at location index.
void	setTitleAt(int index, String newTitle) Sets the title of the child at location index.
void	setTooltipAt(int index, String newTooltip) Sets the tooltip of the child at location index.
protected void	setZOrder(Component component, int order) Sets the z order of component, as higher the z order as later the component is painted, as more components it can overlap.

Methods inherited from class bibliothek.gui.dock.station.stack.tab.AbstractTabPane

addTabPaneListener, createMenu, destroyMenu, discardComponentsAndRebuild, doLayout, fireAdded, fireControllerChanged, fireInfoComponentChanged, fireRemoved, fireSelectionChanged, getController, getDockable, getDockableCount, getDockables, getDockTabPlacement, getInfoComponent, getLayoutManager, getMenu, getMenuList, getMenus, getSelectedDockable, getTab, getTabs, getTabsList, getVisibleTab, getVisibleTabCount, indexOf, indexOfVisible, insert, listeners, menuRemoved, move, newMenu, newTab, putInMenu, removeTabPaneListener, setDockTabPlacement, setInfoComponent, setLayoutManager, tabRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.station.stack.StackDockComponent

getDockTabPlacement, hasBorder, isSingleTabComponent, setDockTabPlacement

Constructor Detail

CombinedStackDockComponent

public CombinedStackDockComponent()

Constructs a new component.

Method Detail

createContentPane

protected CombinedStackDockContentPane createContentPane(CombinedStackDockComponent<T,M,I> self)

Creates the content pane for this component. This method may be called by the constructor.

Parameters:

self - this

Returns:

a new panel, not null

createBackground

protected BackgroundAlgorithm createBackground(CombinedStackDockComponent<T,M,I> self)

Creates the background algorithm that is used for this component. This method may be called by the constructor.

Parameters:

self - this

Returns:

the new algorithm, not null

revalidate

public void revalidate()

Description copied from class: AbstractTabPane

Called when the layout of this pane has become invalid, the default behavior is to call AbstractTabPane.doLayout(). Subclasses may override to update the layout lazily.

Overrides:

revalidate in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

repaint

public void repaint()

Repaints the contents of this component.

addStackDockComponentListener

public void addStackDockComponentListener(StackDockComponentListener listener)

Description copied from interface: StackDockComponent

Adds a listener to this component, it will be called if the selection changes.

Specified by:

addStackDockComponentListener in interface StackDockComponent

Parameters:

listener - the new listener, not null

removeStackDockComponentListener

public void removeStackDockComponentListener(StackDockComponentListener listener)

Description copied from interface: StackDockComponent

Removes listener from this component.

Specified by:

removeStackDockComponentListener in interface StackDockComponent

Parameters:

listener - the listener to remove

fireTabChanged

protected void fireTabChanged(Dockable dockable)

Calls StackDockComponentListener.tabChanged(StackDockComponent, Dockable) on all listeners that are currently registered.

Parameters:

dockable - the element whose tab changed

setController

public void setController(DockController controller)

Description copied from class: AbstractTabPane

Connects this pane with controller.

Specified by:

setController in interface StackDockComponent

Overrides:

setController in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

controller - the realm in which this pane works, may be null

getConfiguration

public TabConfiguration getConfiguration(Dockable child)

Forwards child to the current TabConfigurations, in order to get the matching TabConfiguration.

Parameters:

child - some child of this StackDockComponent

Returns:

the TabConfiguration that should be used for its tab

getTabHandler

public CombinedHandler<CombinedTab> getTabHandler()

Gets a handler for tabs. This handler adds or removes CombinedTabs from this component in order to change their visibility.

Returns:

the handler

getMenuHandler

public CombinedHandler<CombinedMenu> getMenuHandler()

Gets a handler for menus. This handler adds or removes CombinedMenus from this component in order to change their visibility.

Returns:

the handler

getInfoHandler

public CombinedHandler<AbstractTabPaneComponent> getInfoHandler()

Gets a handler for info components. This handler adds or removes AbstractTabPaneComponents from this component in order to change their visibility.

Returns:

the handler

getAvailableArea

public Rectangle getAvailableArea()

Description copied from interface: TabPane

Gets the area in which all the Tabs, TabMenus and the visible Dockable (TabPane.setSelectedBounds(Rectangle)) must find their place.

Specified by:

getAvailableArea in interface TabPane

Returns:

the available space, has at least width and height 1.

getMinimumSize

public Dimension getMinimumSize()

Description copied from class: AbstractTabPane

Gets the minimal size required to have a big enough TabPane.getAvailableArea() to show all content.

Overrides:

getMinimumSize in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Returns:

the minimal size

getPreferredSize

public Dimension getPreferredSize()

Description copied from class: AbstractTabPane

Gets the preferred size required to have a big enough TabPane.getAvailableArea() to show all content.

Overrides:

getPreferredSize in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Returns:

the preferred size

getSelectedBounds

public Rectangle getSelectedBounds()

Description copied from interface: TabPane

Gets the boundaries the selected Dockable has (independent of whether such a Dockable exists).

Specified by:

getSelectedBounds in interface TabPane

Returns:

the boundaries of the selected child, not null

setSelectedBounds

public void setSelectedBounds(Rectangle bounds)

Description copied from interface: TabPane

Sets the boundaries of the selected Dockable.

Specified by:

setSelectedBounds in interface TabPane

Parameters:

bounds - the boundaries of the selected child

getSelectedIndex

public int getSelectedIndex()

Description copied from interface: StackDockComponent

Gets the index of the currently selected dockable

Specified by:

getSelectedIndex in interface StackDockComponent

Returns:

the index

setSelectedIndex

public void setSelectedIndex(int index)

Description copied from interface: StackDockComponent

Selects the component at location index.

Specified by:

setSelectedIndex in interface StackDockComponent

Parameters:

index - the index of the selected component

setSelectedDockable

public void setSelectedDockable(Dockable dockable)

Description copied from class: AbstractTabPane

Selects the child dockable of this pane as the one visible element.

Specified by:

setSelectedDockable in interface TabPane

Overrides:

setSelectedDockable in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

dockable - the newly selected element, can be null

getBoundsAt

public Rectangle getBoundsAt(int index)

Description copied from interface: StackDockComponent

Gets the location and size of the graphical element that allows the user to select the index'th child.

Specified by:

getBoundsAt in interface StackDockComponent

Parameters:

index - the index of the child

Returns:

the bounds of the graphical selection-element, null if the element is not directly visible

getIndexOfTabAt

public int getIndexOfTabAt(Point mouseLocation)

Description copied from interface: StackDockComponent

Gets the index of the tab that is beneath mouseLocation.

Specified by:

getIndexOfTabAt in interface StackDockComponent

Parameters:

mouseLocation - the location of the mouse on the component

Returns:

the index of a tab or -1

getTabCount

public int getTabCount()

Description copied from interface: StackDockComponent

Gets the number of children that are added to this StackDockComponent.

Specified by:

getTabCount in interface StackDockComponent

Returns:

the number of children

addTab

public void addTab(String title,
                   Icon icon,
                   Component comp,
                   Dockable dockable)

Description copied from interface: StackDockComponent

Adds a new child at an unspecified location.

Specified by:

addTab in interface StackDockComponent

Parameters:

title - the title of the child

icon - an icon to display for the child or null

comp - the new child to display

dockable - the Dockable for which the tab is used

insertTab

public void insertTab(String title,
                      Icon icon,
                      Component comp,
                      Dockable dockable,
                      int index)

Description copied from interface: StackDockComponent

Adds a new child at the location index.

Specified by:

insertTab in interface StackDockComponent

Parameters:

title - the title of the child

icon - an icon to display for the child or null

comp - the new child to display

dockable - the Dockable for which the tab is used

index - the index that the new child should have

getMinimumSize

public Dimension getMinimumSize(Dockable dockable)

Description copied from interface: TabPane

Gets the minimum size that is required to show the child dockable.

Specified by:

getMinimumSize in interface TabPane

Parameters:

dockable - one of the children of this pane

Returns:

the minimum size required to show dockable

getPreferredSize

public Dimension getPreferredSize(Dockable dockable)

Description copied from interface: TabPane

Gets the preferred size that is required to show the child dockable.

Specified by:

getPreferredSize in interface TabPane

Parameters:

dockable - one of the children of this pane

Returns:

the preferred size required to show dockable

getDockableAt

public Dockable getDockableAt(int index)

Description copied from interface: StackDockComponent

Gets the Dockable which was placed at the index'th position.

Specified by:

getDockableAt in interface StackDockComponent

Parameters:

index - the position of the element

Returns:

the element

getTabAt

public DockElementRepresentative getTabAt(int index)

Description copied from interface: StackDockComponent

Gets an element representing the tab of the Dockable at index.

Specified by:

getTabAt in interface StackDockComponent

Parameters:

index - the index of some child of this stack

Returns:

the tab or null if no tab exists or tabs cannot be used as DockElementRepresentatives

moveTab

public void moveTab(int source,
                    int destination)

Description copied from interface: StackDockComponent

Moves the tab at source to location destination.

Specified by:

moveTab in interface StackDockComponent

Parameters:

source - the item to move

destination - the target destination

remove

public void remove(int index)

Description copied from class: AbstractTabPane

Removes the index'th element of this pane.

Specified by:

remove in interface StackDockComponent

Overrides:

remove in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

index - the index of the element to remove

removeAll

public void removeAll()

Description copied from class: AbstractTabPane

Removes all elements from this pane.

Specified by:

removeAll in interface StackDockComponent

Overrides:

removeAll in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

putOnTab

public T putOnTab(Dockable dockable)

Description copied from interface: TabPane

Informs this pane that its child dockable should have a tab-button. This TabPane may create a new Tab or reuse an existing Tab. Reusing an existing tab is recommended. If dockable was part of a TabMenu, then it should be removed from that menu.
If dockable already is on a tab then this tab should be reused.

Specified by:

putOnTab in interface TabPane

Overrides:

putOnTab in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

dockable - the element which needs a tab-button

Returns:

a Tab that is only used for dockable

getOnTab

public T getOnTab(Dockable dockable)

Description copied from interface: TabPane

Gets the tab-button for dockable, if no tab-button for dockable exists a new button should be created. Reusing existing tabs is recommended. Other than TabPane.putOnTab(Dockable) this method must not affect any TabMenu showing Dockable.

Specified by:

getOnTab in interface TabPane

Overrides:

getOnTab in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

dockable - the element whose tab is requested

Returns:

the tab matching dockable

putTab

protected T putTab(Dockable dockable,
                   T tab)

Description copied from class: AbstractTabPane

Associates tab with dockable. this method modifies the internal data structure in order to store the change.
Subclasses may override this method to be informed about the exact time when a tab changes, but the overriden method must call the original method.

Overrides:

putTab in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

dockable - the key for the tab-map

tab - the value for the tab-map

Returns:

the old tab at dockable

removeTab

protected T removeTab(Dockable dockable)

Description copied from class: AbstractTabPane

Removes the tab of dockable from the internal data structure.

Overrides:

removeTab in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

dockable - the key of the element to be removed from the tab-map
Subclasses may override this method to be informed about the exact time when a tab changes, but the overriden method must call the original method.

Returns:

the removed element

clearTabs

protected void clearTabs()

Description copied from class: AbstractTabPane

Removes all tabs from the internal data structure.
Subclasses may override this method to be informed about the exact time when a tab changes, but the overriden method must call the original method.

Overrides:

clearTabs in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

addToMenu

protected void addToMenu(M menu,
                         Dockable dockable)

Description copied from class: AbstractTabPane

Adds dockable somewhere to menu

Specified by:

addToMenu in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

menu - a menu of this pane

dockable - a new child of menu

removeFromMenu

protected void removeFromMenu(M menu,
                              Dockable dockable)

Description copied from class: AbstractTabPane

Removes dockable from menu.

Specified by:

removeFromMenu in class AbstractTabPane<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

Parameters:

menu - some menu of this pane

dockable - a child of menu

createLayerAt

protected Component createLayerAt(Component component,
                                  Dockable dockable)

Creates a layer between component and this panel. The object component is a representation of dockable but not necessarily dockable itself. The default behavior of this method is to return component.

Parameters:

component - the representation of dockable

dockable - the element for which a new layer is created

Returns:

the new layer which must be a parent of component or component

getLayerAt

public Component getLayerAt(int index)

Gets the index'th Component on this tab. This Component is not a Dockable but a layer between dockable and this panel.

Parameters:

index - the index of a tab.

Returns:

the layer between tab and dockable

getContentAt

protected CombinedStackDockComponent.Meta getContentAt(int index)

Gets the meta information about the components at location index

Parameters:

index - the index of a tab

Returns:

information about that tab

setTitleAt

public void setTitleAt(int index,
                       String newTitle)

Description copied from interface: StackDockComponent

Sets the title of the child at location index.

Specified by:

setTitleAt in interface StackDockComponent

Parameters:

index - the index of the child

newTitle - the new title

setTooltipAt

public void setTooltipAt(int index,
                         String newTooltip)

Description copied from interface: StackDockComponent

Sets the tooltip of the child at location index.

Specified by:

setTooltipAt in interface StackDockComponent

Parameters:

index - the index of the child

newTooltip - the new tooltip, can be null

setIconAt

public void setIconAt(int index,
                      Icon newIcon)

Description copied from interface: StackDockComponent

Sets the icon of the child at location index.

Specified by:

setIconAt in interface StackDockComponent

Parameters:

index - the index of the child

newIcon - the new icon, null if no icon should be displayed

setComponentAt

public void setComponentAt(int index,
                           Component component)

Description copied from interface: StackDockComponent

Sets the component which should be shown at tab index.

Specified by:

setComponentAt in interface StackDockComponent

Parameters:

index - the index where to show component

component - the new content, not null

setEnabledAt

protected void setEnabledAt(Dockable dockable,
                            boolean enabled)

Changes the enabled state of the item dockable.

Parameters:

dockable - the tab whose state is to be changed

enabled - the new enabled state

getComponent

public JComponent getComponent()

Description copied from interface: StackDockComponent

Gets a Component on which the children of this StackDockComponent will be displayed.

Specified by:

getComponent in interface StackDockComponent

Returns:

the Component

setZOrder

protected void setZOrder(Component component,
                         int order)

Sets the z order of component, as higher the z order as later the component is painted, as more components it can overlap.

Parameters:

component - some child of this pane

order - the order

getZOrder

protected int getZOrder(Component component)

Gets the z order of component.

Parameters:

component - some child of this pane

Returns:

the order

createDefaultRepresentation

public DockElementRepresentative createDefaultRepresentation(DockElement target)

Description copied from interface: StackDockComponent

Creates and returns a new DockElementRepresentative representing target, the new representation is to be used to cover all the empty areas on this StackDockComponent.

Specified by:

createDefaultRepresentation in interface StackDockComponent

Parameters:

target - the target for the new representative, may or may not be a child of this component, not null

Returns:

the new representation, can be null if this StackDockComponent does not allow to use its free spaces

createContentBorderModifier

protected BorderForwarder createContentBorderModifier(Dockable dockable,
                                                      JComponent component)

Creates a BorderForwarder for the content component for the tab of dockable

Parameters:

dockable - the item that is shown

component - the component which is influenced

Returns:

the forwarder or null