net.xoetrope.swing.docking
Class XDockable

java.lang.Object
  net.xoetrope.swing.docking.XDockable

public class XDockable
extends java.lang.Object

XDockable 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) Xoetrope Ltd., 1998-2006
License: see license.txt

Field Summary

boolean	canClose
boolean	canDock
boolean	canDrag
boolean	canMinimize
boolean	canZoom
java.lang.String	constraint
java.awt.Container	content
XDockingPanel	dockedContainer
XDockingSideBar	dockingSideBar
boolean	hasDockingTitle
XDockableHeader	header
javax.swing.ImageIcon	icon
XDockingSideBar.XDockButton	launchContainer
XDockingPreview	previewContainer
int	state
java.lang.String	title

Constructor Summary

XDockable(XDockingSideBar sb, java.lang.String title)
Creates a new instance of XDockable

XDockable(XDockingSideBar sb, java.lang.String title, java.lang.String constraint)
Creates a new instance of XDockable

Method Summary

XCardPanel	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 XDockableHeader header

dockingSideBar

public XDockingSideBar dockingSideBar

launchContainer

public XDockingSideBar.XDockButton launchContainer

previewContainer

public XDockingPreview previewContainer

dockedContainer

public XDockingPanel 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

XDockable

public XDockable(XDockingSideBar sb,
                 java.lang.String title)

Creates a new instance of XDockable

Parameters:

sb - the sidebar to which the content docks.

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

XDockable

public XDockable(XDockingSideBar sb,
                 java.lang.String title,
                 java.lang.String constraint)

Creates a new instance of XDockable

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 XCardPanel getCardPanel()