bibliothek.gui.dock.station.stack

Class CombinedStackDockComponent.Meta

java.lang.Object

bibliothek.gui.dock.station.stack.CombinedStackDockComponent.Meta

Enclosing class:

CombinedStackDockComponent<T extends CombinedTab,M extends CombinedMenu,I extends CombinedInfoComponent>

protected class CombinedStackDockComponent.Meta
extends Object

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

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
Meta(Dockable dockable, Component component, String text, Icon icon, String tooltip, boolean enabled) Creates new meta information.

Method Summary

Modifier and Type	Method and Description
void	forward() Searches CombinedTab or CombinedMenu of dockable and updates text, icon and tooltip.
Component	getComponent() Gets the component that is shown.
Dockable	getDockable() Gets the element which is represented by this object
void	setBorder(Border border) Sets the border of the component.
void	setController(DockController controller) Sets the controller which is used to read values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Meta

public Meta(Dockable dockable,
            Component component,
            String text,
            Icon icon,
            String tooltip,
            boolean enabled)

Creates new meta information.

Parameters:

dockable - the element for which the meta information is required

component - graphical representation of dockable

text - text to be shown in the tab

icon - icon to be shown in the tab

tooltip - tooltip to be shown on the tab

enabled - whether this tab is enabled or not

Method Detail

setController

@FrameworkOnly
public void setController(DockController controller)

Sets the controller which is used to read values.

Parameters:

controller - the new controller

getDockable

public Dockable getDockable()

Gets the element which is represented by this object

Returns:

the dockable

getComponent

public Component getComponent()

Gets the component that is shown.

Returns:

the component to show

setBorder

public void setBorder(Border border)

Sets the border of the component. This method assumes that CombinedStackDockComponent.createContentBorderModifier(Dockable, JComponent) returns a non-null value.

Parameters:

border - the new border, can be null

forward

public void forward()

Searches CombinedTab or CombinedMenu of dockable and updates text, icon and tooltip.