Package bibliothek.gui.dock.common

Class DefaultMultipleCDockable

java.lang.Object

bibliothek.gui.dock.common.intern.AbstractCDockable

bibliothek.gui.dock.common.intern.DefaultCDockable

bibliothek.gui.dock.common.DefaultMultipleCDockable

All Implemented Interfaces:

CDockable, MultipleCDockable

@ClientOnly
public class DefaultMultipleCDockable
extends DefaultCDockable
implements MultipleCDockable

A MultipleCDockable that contains a content-pane where the client might add or remove as many Components as it wishes.

Author:

Benjamin Sigg

See Also:

• MultipleCDockable

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
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, CAction... actions)	Creates a new dockable
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Component content, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, String title, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, String title, Component content, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, IconHandling iconHandling, String title, Component content, DefaultCDockable.Permissions permissions, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, Component content, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, String title, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, String title, Component content, CAction... actions)	Creates a new dockable.
DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory, Icon icon, String title, Component content, DefaultCDockable.Permissions permissions, CAction... actions)	Creates a new dockable.

Method Summary

Modifier and Type	Method	Description
MultipleCDockableFactory<?,?>	getFactory()	Gets the factory that created this dockable.
boolean	isRemoveOnClose()	Tells whether this MultipleCDockable should be removed from the CControl when it is made invisible.
void	setControlAccess(CControlAccess control)	Sets the CControl which is responsible for this CDockable.
void	setRemoveOnClose(boolean removeOnClose)	Sets whether this dockable will be removed from the CControl when made invisible.

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, 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, setExtendedMode, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setSticky, setStickySwitchable, setVisible, setWorkingArea

Constructor Details

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 CAction... actions)

Creates a new dockable

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 String title,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 String title,
 Component content,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 String title,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 String title,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 String title,
 Component content,
 DefaultCDockable.Permissions permissions,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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.

DefaultMultipleCDockable

public DefaultMultipleCDockable(MultipleCDockableFactory<?,?> factory,
 Icon icon,
 IconHandling iconHandling,
 String title,
 Component content,
 DefaultCDockable.Permissions permissions,
 CAction... actions)

Creates a new dockable.

Parameters:

factory - the factory which created or could create this kind of dockable. A value of null will default ot the NullMultipleCDockableFactory.

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

iconHandling - what to do 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

getFactory

public MultipleCDockableFactory<?,?> getFactory()

Gets the factory that created this dockable.

Specified by:

getFactory in interface MultipleCDockable

Returns:

the factory, not null

setControlAccess

public void setControlAccess(CControlAccess control)

Description copied from interface: CDockable

Sets the CControl which is responsible for this CDockable. Subclasses must call CControlAccess.link(CDockable, CDockableAccess) to grant the CControl access to the internal properties of this CDockable. link can also be used to revoke access.

Specified by:

setControlAccess in interface CDockable

Overrides:

setControlAccess in class AbstractCDockable

Parameters:

control - the new control or null

isRemoveOnClose

public boolean isRemoveOnClose()

Description copied from interface: MultipleCDockable

Tells whether this MultipleCDockable should be removed from the CControl when it is made invisible. If in doubt, return true.

Specified by:

isRemoveOnClose in interface MultipleCDockable

Returns:

true if this dockable should be removed from the controller when made invisible.

setRemoveOnClose

public void setRemoveOnClose(boolean removeOnClose)

Sets whether this dockable will be removed from the CControl when made invisible.

Parameters:

removeOnClose - true if this element should be removed automatically.