Package bibliothek.gui.dock.common

Class DefaultSingleCDockable

java.lang.Object

bibliothek.gui.dock.common.intern.AbstractCDockable

bibliothek.gui.dock.common.intern.DefaultCDockable

bibliothek.gui.dock.common.DefaultSingleCDockable

All Implemented Interfaces:

CDockable, SingleCDockable

@ClientOnly
public class DefaultSingleCDockable
extends DefaultCDockable
implements SingleCDockable

A DefaultSingleCDockable is an element which has a content-pane where clients can add or remove as many Components as they whish.

Author:

Benjamin Sigg

See Also:

• SingleCDockable

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.common.intern.DefaultCDockable

DefaultCDockable.Permissions

Field Summary

Fields inherited from class bibliothek.gui.dock.common.intern.AbstractCDockable

listenerCollection

Fields inherited from interface bibliothek.gui.dock.common.intern.CDockable

ACTION_KEY_CLOSE, ACTION_KEY_EXTERNALIZE, ACTION_KEY_MAXIMIZE, ACTION_KEY_MINIMIZE, ACTION_KEY_MINIMIZE_HOLD, ACTION_KEY_NORMALIZE, ACTION_KEY_UNEXTERNALIZE, ACTION_KEY_UNMAXIMIZE_EXTERNALIZED

Constructor Summary

Constructors

Constructor	Description
DefaultSingleCDockable(String id, CAction... actions)	Creates a new dockable
DefaultSingleCDockable(String id, Component content, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, String title, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, String title, Component content, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, IconHandling iconHandling, String title, Component content, DefaultCDockable.Permissions permissions, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, Component content, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, String title, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, String title, Component content, CAction... actions)	Creates a new dockable.
DefaultSingleCDockable(String id, Icon icon, String title, Component content, DefaultCDockable.Permissions permissions, CAction... actions)	Creates a new dockable.

Method Summary

Modifier and Type	Method	Description
String	getUniqueId()	Gets the id of this dockable.

Methods inherited from class bibliothek.gui.dock.common.intern.DefaultCDockable

add, add, addAction, addSeparator, asStation, createCommonDockable, getAction, getActionCount, getContentPane, getTitleIcon, getTitleIconHandling, getTitleText, getTitleToolTip, insertAction, insertSeparator, intern, isCloseable, isExternalizable, isMaximizable, isMinimizable, isStackable, remove, removeAction, removeAction, setCloseable, setExternalizable, setLayout, setMaximizable, setMinimizable, setStackable, setTitleIcon, setTitleIconHandling, setTitleText, setTitleToolTip

Methods inherited from class bibliothek.gui.dock.common.intern.AbstractCDockable

addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, control, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getClose, getColors, getControl, getControlAccess, getDefaultLocation, getDockableUniqueId, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, init, isDockableVisible, isEnabled, isNormalizeable, isResizeLocked, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isSticky, isStickySwitchable, isTitleShown, isVisible, propertyListeners, putAction, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setControlAccess, setDefaultLocation, setEnabled, setExtendedMode, setFocusComponent, setGrouping, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setResizeLocked, setResizeLockedHorizontally, setResizeLockedVertically, setResizeRequest, setResizeRequest, setSingleTabShown, setSticky, setStickySwitchable, setTitleShown, setVisible, setWorkingArea, stateListeners, toFront, toFront, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.common.intern.CDockable

addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, asStation, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getColors, getControl, getControlAccess, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, intern, isCloseable, isDockableVisible, isEnabled, isExternalizable, isMaximizable, isMinimizable, isNormalizeable, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isStackable, isSticky, isStickySwitchable, isTitleShown, isVisible, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setControlAccess, setExtendedMode, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setSticky, setStickySwitchable, setVisible, setWorkingArea

Constructor Details

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 CAction... actions)

Creates a new dockable

Parameters:

id - a unique id, not null

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

content - a Component which will be shown in the middle of this dockable, can be null.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 String title,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

title - the text shown in the title, can be null

content - a Component which will be shown in the middle of this dockable, can be null.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

content - a Component which will be shown in the middle of this dockable, can be null.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 String title,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

title - the text shown in the title, can be null

content - a Component which will be shown in the middle of this dockable, can be null.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 String title,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

title - the text shown in the title, can be null

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 String title,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

title - the text shown in the title, can be null

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 String title,
 Component content,
 DefaultCDockable.Permissions permissions,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

title - the text shown in the title, can be null

content - a Component which will be shown in the middle of this dockable, can be null.

permissions - what actions the user is allowed to do, null will be replaced by DefaultCDockable.Permissions.DEFAULT.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

DefaultSingleCDockable

public DefaultSingleCDockable(String id,
 Icon icon,
 IconHandling iconHandling,
 String title,
 Component content,
 DefaultCDockable.Permissions permissions,
 CAction... actions)

Creates a new dockable.

Parameters:

id - the unique id, must not be null

icon - the icon shown in the title, can be null

iconHandling - how to behave if icon is null

title - the text shown in the title, can be null

content - a Component which will be shown in the middle of this dockable, can be null.

permissions - what actions the user is allowed to do, null will be replaced by DefaultCDockable.Permissions.DEFAULT.

actions - the actions shown in the title, can be null. A separator is inserted for every entry that is null of this array.

Method Details

getUniqueId

public String getUniqueId()

Gets the id of this dockable. The id is unique among all dockables which are added to the same CControl.

Specified by:

getUniqueId in interface SingleCDockable

Returns:

the unique id