org.formaria.swing.docking
Class Dockable

java.lang.Object
  org.formaria.swing.docking.Dockable

public class Dockable
extends java.lang.Object

Dockable is a collection of information about a dockable component, its decorations and its docked location(s). As the dockable object is passed from one container to another it is the responsibility of the various participating objects to update the state of this object.

Copyright: (c) Formaria Ltd., 2008
License: see license.txt

Field Summary

boolean	canClose
boolean	canDock
boolean	canDrag
boolean	canMinimize
boolean	canZoom
java.lang.String	constraint
java.awt.Container	content
DockingPanel	dockedContainer
DockingSideBar	dockingSideBar
boolean	hasDockingTitle
DockableHeader	header
javax.swing.ImageIcon	icon
DockingSideBar.DockButton	launchContainer
DockingPreview	previewContainer
int	state
java.lang.String	title

Constructor Summary

Dockable(DockingSideBar sb, java.lang.String title)
Creates a new instance of Dockable

Dockable(DockingSideBar sb, java.lang.String title, java.lang.String constraint)
Creates a new instance of Dockable

Method Summary

CardPanel	getCardPanel()
java.lang.String	getId() Get the unique ID of this dockable component

Methods inherited from class java.lang.Object

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

Field Detail

title

public java.lang.String title

constraint

public java.lang.String constraint

content

public java.awt.Container content

header

public DockableHeader header

dockingSideBar

public DockingSideBar dockingSideBar

launchContainer

public DockingSideBar.DockButton launchContainer

previewContainer

public DockingPreview previewContainer

dockedContainer

public DockingPanel dockedContainer

icon

public javax.swing.ImageIcon icon

state

public int state

canClose

public boolean canClose

canMinimize

public boolean canMinimize

canDock

public boolean canDock

canDrag

public boolean canDrag

canZoom

public boolean canZoom

hasDockingTitle

public boolean hasDockingTitle

Constructor Detail

Dockable

public Dockable(DockingSideBar sb,
                java.lang.String title)

Creates a new instance of Dockable

Parameters:

sb - the sidebar to which the content docks.

title - the display name of the dockable and the docking constraint of the dockable

Dockable

public Dockable(DockingSideBar sb,
                java.lang.String title,
                java.lang.String constraint)

Creates a new instance of Dockable

Parameters:

sb - the sidebar to which the content docks.

title - the display name of the dockable

constraint - the docking constraint of the dockable

Method Detail

getId

public java.lang.String getId()

Get the unique ID of this dockable component

Returns:

the ID

getCardPanel

public CardPanel getCardPanel()