/usr/share/doc/libvldocking-java/api/com/vlsolutions/swing/docking/package-summary.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Thu Aug 18 18:34:03 UTC 2011 -->
<TITLE>
com.vlsolutions.swing.docking (VLSolutions Docking Framework 2.1-beta API)
</TITLE>

<META NAME="date" CONTENT="2011-08-18">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="com.vlsolutions.swing.docking (VLSolutions Docking Framework 2.1-beta API)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../../com/vlsolutions/swing/docking/animation/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/vlsolutions/swing/docking/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<H2>
Package com.vlsolutions.swing.docking
</H2>
The VL Docking Framework for JFC "Swing" applications.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/Dockable.html" title="interface in com.vlsolutions.swing.docking">Dockable</A></B></TD>
<TD>Interface describing a component (AWT/Swing) that can be managed by the
 DockingDesktop.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableContainer.html" title="interface in com.vlsolutions.swing.docking">DockableContainer</A></B></TD>
<TD>A DockableContainer is the base interface of GUI components used to
 display <code>Dockable</code> components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableDragSource.html" title="interface in com.vlsolutions.swing.docking">DockableDragSource</A></B></TD>
<TD>An interface implemented by visual components used for drag and drop operations
 on a DockableContainer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableResolver.html" title="interface in com.vlsolutions.swing.docking">DockableResolver</A></B></TD>
<TD>An interface used to find a dockable (when read from an input stream like XML)
 when the only information given is its DockKey id.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockDropReceiver.html" title="interface in com.vlsolutions.swing.docking">DockDropReceiver</A></B></TD>
<TD>An interface implemented by components that can accept docking action with mouse drag and drop.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/FloatingDockableContainer.html" title="interface in com.vlsolutions.swing.docking">FloatingDockableContainer</A></B></TD>
<TD>The interface describing a Floating window used to display one or more dockables</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/SingleDockableContainer.html" title="interface in com.vlsolutions.swing.docking">SingleDockableContainer</A></B></TD>
<TD>A SingleDockableContainer is a DockableContainer that can display
 a single <code>Dockable</code> component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/TabbedDockableContainer.html" title="interface in com.vlsolutions.swing.docking">TabbedDockableContainer</A></B></TD>
<TD>Interface describing a container that can be used to display more than
 one Dockable in a Tabbed Pane fashion.</TD>
</TR>
</TABLE>
&nbsp;

<P>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AnchorConstraints.html" title="class in com.vlsolutions.swing.docking">AnchorConstraints</A></B></TD>
<TD>A constraint used to specify how a dockable is tied (anchored) to its containing parent .</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AnchorManager.html" title="class in com.vlsolutions.swing.docking">AnchorManager</A></B></TD>
<TD>A helper class used to specify and enforce constraints within a container
 (DockingPanel or CompoundDockingPanel).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AutoHideBorderLayout.html" title="class in com.vlsolutions.swing.docking">AutoHideBorderLayout</A></B></TD>
<TD>A Layout Manager for auto-hide borders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AutoHideButton.html" title="class in com.vlsolutions.swing.docking">AutoHideButton</A></B></TD>
<TD>The button used to show Dockables in auto-hide borders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AutoHideButtonPanel.html" title="class in com.vlsolutions.swing.docking">AutoHideButtonPanel</A></B></TD>
<TD>A Swing panel used as a toolbar for autohide buttons.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AutoHideExpandPanel.html" title="class in com.vlsolutions.swing.docking">AutoHideExpandPanel</A></B></TD>
<TD>A component used to show the currently expanded view.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/AutoHidePolicy.html" title="class in com.vlsolutions.swing.docking">AutoHidePolicy</A></B></TD>
<TD>This class holds preferences on default autohiding behaviour.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/BorderSplitter.html" title="class in com.vlsolutions.swing.docking">BorderSplitter</A></B></TD>
<TD>An utility class used to delegate the border drag/drop scanning for docking (
 since the same code is used in many DockDropReceivers).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/CompoundDockable.html" title="class in com.vlsolutions.swing.docking">CompoundDockable</A></B></TD>
<TD>Describes a Dockable that can contain sub-dockables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/CompoundDockingPanel.html" title="class in com.vlsolutions.swing.docking">CompoundDockingPanel</A></B></TD>
<TD>A specialized container used to nest dockables inside that sub-part of the
 desktop.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DefaultDockableContainerFactory.html" title="class in com.vlsolutions.swing.docking">DefaultDockableContainerFactory</A></B></TD>
<TD>Default implementation of the DockableContainerFactory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DetachedDockView.html" title="class in com.vlsolutions.swing.docking">DetachedDockView</A></B></TD>
<TD>A DockView suitable for detached dockables (in their own window).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableActionCustomizer.html" title="class in com.vlsolutions.swing.docking">DockableActionCustomizer</A></B></TD>
<TD>An objet that can provide actions relative to a dockable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableContainerFactory.html" title="class in com.vlsolutions.swing.docking">DockableContainerFactory</A></B></TD>
<TD>An abstract factory used by the <code>DockingDesktop</code> to create instance
 of Dockable containers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockablePanel.html" title="class in com.vlsolutions.swing.docking">DockablePanel</A></B></TD>
<TD>A basic implementation of Dockable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableState.html" title="class in com.vlsolutions.swing.docking">DockableState</A></B></TD>
<TD>General information about the current state of a dockable component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockableStoreButton.html" title="class in com.vlsolutions.swing.docking">DockableStoreButton</A></B></TD>
<TD>A Button that can be used to store a dockable (for example to allow moving a dockable
 between two workspaces).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockGroup.html" title="class in com.vlsolutions.swing.docking">DockGroup</A></B></TD>
<TD>This class describes a logical group of Dockables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingBorderLayout.html" title="class in com.vlsolutions.swing.docking">DockingBorderLayout</A></B></TD>
<TD>A layout adapted to autohide panels.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingConstants.html" title="class in com.vlsolutions.swing.docking">DockingConstants</A></B></TD>
<TD>Constants used by the DockingDesktop to position Dockables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingConstants.Hide.html" title="class in com.vlsolutions.swing.docking">DockingConstants.Hide</A></B></TD>
<TD>Typesafe enumeration describing an auto-hide  operation on the DockingDesktop.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingConstants.Split.html" title="class in com.vlsolutions.swing.docking">DockingConstants.Split</A></B></TD>
<TD>Typesafe enumeration describing a split operation on the DockingDesktop.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingContext.html" title="class in com.vlsolutions.swing.docking">DockingContext</A></B></TD>
<TD>A context that can be shared by multiple docking desktops.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingDesktop.html" title="class in com.vlsolutions.swing.docking">DockingDesktop</A></B></TD>
<TD>The DockingDesktop is the main class of the VLDocking Framework.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingPanel.html" title="class in com.vlsolutions.swing.docking">DockingPanel</A></B></TD>
<TD>This class is responsible for the containment of a Dockable component.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingPreferences.html" title="class in com.vlsolutions.swing.docking">DockingPreferences</A></B></TD>
<TD>This is the centralized settings repository for managing docking look and feel.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingSelectorDialog.html" title="class in com.vlsolutions.swing.docking">DockingSelectorDialog</A></B></TD>
<TD>A Helper class providing information about the visibility of user components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockingUtilities.html" title="class in com.vlsolutions.swing.docking">DockingUtilities</A></B></TD>
<TD>Utility class implementing search/replace algorithms used by the framework.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockKey.html" title="class in com.vlsolutions.swing.docking">DockKey</A></B></TD>
<TD>Provides a unique identification for a Dockable and runtime properties, like icon, name,
 tooltip, preferred audohide-zone...</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockTabbedPane.html" title="class in com.vlsolutions.swing.docking">DockTabbedPane</A></B></TD>
<TD>A JTabbedPane customized for integration with the docking framework.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockView.html" title="class in com.vlsolutions.swing.docking">DockView</A></B></TD>
<TD>DefaultImplementation of the SingleDockableContainer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockViewAsTab.html" title="class in com.vlsolutions.swing.docking">DockViewAsTab</A></B></TD>
<TD>This component is used to display single dockables like if they were in a tabbed pane.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/DockViewTitleBar.html" title="class in com.vlsolutions.swing.docking">DockViewTitleBar</A></B></TD>
<TD>A title bar, associated to a DockView (container of a single user component).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/FloatingDialog.html" title="class in com.vlsolutions.swing.docking">FloatingDialog</A></B></TD>
<TD>The floating jdialog for floatable dockables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/MaximizedDockView.html" title="class in com.vlsolutions.swing.docking">MaximizedDockView</A></B></TD>
<TD>A dockView suitable for maximized dockables</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/MaximizedDockViewAsTab.html" title="class in com.vlsolutions.swing.docking">MaximizedDockViewAsTab</A></B></TD>
<TD>A maximized view to use with the TabFactory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/RelativeDockablePosition.html" title="class in com.vlsolutions.swing.docking">RelativeDockablePosition</A></B></TD>
<TD>This class is an immutable object used to remember the relative positionning
 of docked components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/ShadowBorder.html" title="class in com.vlsolutions.swing.docking">ShadowBorder</A></B></TD>
<TD>A border using a shadow on right-bottom sides.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/SplitContainer.html" title="class in com.vlsolutions.swing.docking">SplitContainer</A></B></TD>
<TD>A Specialized JSplitPane which accepts drag and drop of DockableContainer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/TabbedContainerActions.html" title="class in com.vlsolutions.swing.docking">TabbedContainerActions</A></B></TD>
<TD>An utility class providing default implementation of usefull actions for pop-up
 menus in tab container selectors.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/TabbedDockView.html" title="class in com.vlsolutions.swing.docking">TabbedDockView</A></B></TD>
<TD>A DockView that can be nested into a TabbedDockableContainer</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/vlsolutions/swing/docking/TabFactory.html" title="class in com.vlsolutions.swing.docking">TabFactory</A></B></TD>
<TD>A factory that replaces DockViews (with title headers) by tabbed panes with a single tab.</TD>
</TR>
</TABLE>
&nbsp;

<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.vlsolutions.swing.docking Description
</H2>

<P>
<h1>The VL Docking Framework for JFC "Swing" applications. </h1>
<p align="center"><img  src="doc-files/docking.gif"></p>
<h2>Goals.</h2>
The VLSolutions Docking Framework provides a means to add docking capabilities into a Swing
application with minor modification of the components hierarchy (only decoration of
existing components and containers and adding of a new root container).
<h2>Audience.</h2>
<p> This javadoc is targetted to :
  <ul>
    <li> API Users : developpers of "User Applications"
    <li> API Extenders : developpers that want to extend the framework, add new
      kinds of containers, or change the look and feel of existing ones.
  </ul>
<p>
You will find in this documentation references of those targets, indicating you if
you have to read such document or not, depending on your goals
(developping a "User Application" or extending the API).


<h2>For API Users</h2>
<h3> Basic Description </h3>
<P> The VL Docking Framework is a set of Swing Components that is used to enhance any
Swing Application by providing <b>Docking capabilities </b> to user components : </P>
<P> A user component can be any Swing JComponent (usualy a JPanel or a JScrollPane).</P>
<P> Docking functions are built upon the following classes :
<UL>
  <LI> <code>DockingDesktop</code> : the root container of a docking-enabled application
  <li> <code>Dockable</code> : an interface implemented (usually) by components that need
    docking capabilities.
  <li> <code>DockableContainer</code>s : specialized containers with drag and drop extensions
    (come in two flavors, SingleDockableContainer and TabbedDockabeContainer).
  <li> <code>DockKey</code> : a JavaBeans object fully describing the dockable (use for save/load, and for
    DockableContainers customization) : name, icon, tooltip, docking features.
</UL>
<h3> The <code>DockingDesktop</code> class. </h3>
<p>There is usually only one DockingDesktop associated to a Window.
<p>For developpers used to <code>JInternalFrame</code> API, the DockingDesktop is equivalent
  to the <code>JDesktopPane</code> : a layered pane capable of managing and displaying
  multiple components, with overlapping when needed.
<p> The desktop is composed of :
  <ul>
  <li> 4 auto-hide zones (on borders ) displaying buttons
    that are used to activate or hide their <code>Dockable</code>.
  <li> a central zone, for visible Dockables (or "docked" components).
  </ul>
<p> The central zone contains a <code>DockableContainer</code> that can be
  recursively splitted in two (horizontally or vertically) to add
  more DockableContainers. Each split acts
  as a JSplitPane, and can be resized by the end-user or with the API.

<h3> The <code>Dockable</code> interface </h3>

The <code>Dockable</code> is implemented by dockable component providers or, simply
by <b>components that want to benefit of the docking features</b>.
<p> If you already have a working application (without docking) and want to use
  the docking framework, take your GUI major components, have them implement
  the Dockable interface (only 2 methods) and you will be able to add them to
  the docking desktop.
<p><i>Alternatively, you can use DockablePanel which is a JPanel container
  implementing Dockable.</i>

<h3> The <code>DockableContainer</code>, <code>SingleDockableContainer</code> and
  <code>TabbedDockableContainer</code> interfaces.</h3>
These interfaces are implemented by containers of Dockables. Usually you will not
interact with them (except if you want to extend the framework).
<h3> The <code>DockKey</code> class</h3>
This one is important because it fully describes the Docking presentation of
your dockables, and their behaviour.
<p> A DockKey is used in 3 situations :
<ul>
  <li> the <code>DockingDesktop</code> needs a unique key to identify a dockable
    (for read/write operations)
  <li> the <code>DockableContainer</code> displaying a <code>Dockable</code> wants
    information about the dockable : a name, an icon, ...
  <li> and finally, the DockingDesktop and DockableContainer only allow docking
    features associated to that DockKey (maximizeable, closeable, hidable...).
</ul>
<p> So keep in mind that each dockable must have a unique DockKey (it's a kind of
  primary key) and that the key, as a javabean, is used to decorate the
  dockable container.
<p> Listeners : most DockKey properties are bound, and changing their value will have
  an immediate effect on the DockingDesktop : for example, you can change the icon
  property of a key and it will be propagated to the DockableContainer's title bar of
  its dockable.
<hr>
 <h2> Getting Started </h2>
   It's easy, just follow the steps below, or have a look at the tutorial on
   <a href="http://www.vlsolutions.com/en/documention/docking/tutorial">
     www.vlsolutions.com/en/documention/docking/tutorial</a>.
 <h3> Creating a small sample application :    </h3>
 <p align="center">  <img src="doc-files/sample1.gif"></p>
 Here is a working code showing a simple frame with dockable buttons.
<pre>

import com.vlsolutions.swing.docking.*;
import javax.swing.*;
import java.awt.*;

public class DemoFrame extends JFrame {
  // our docking desktop
  DockingDesktop desk = new DockingDesktop();

  public DemoFrame(){
    setDefaultCloseOperation(DISPOSE_ON_CLOSE);
    getContentPane().add(desk);

    // first, create 4 dockable buttons (inner class below)
    DockableButton button1 = new DockableButton("Dockable 1");
    DockableButton button2 = new DockableButton("Dockable 2");
    DockableButton button3 = new DockableButton("Dockable 3");
    DockableButton button4 = new DockableButton("Dockable 4");
    // first button at center
    desk.addDockable(button1);

    // second and third button splitted vertically on the left of center
    // first parameter is the "reference", second is the added dockable
    desk.split(button1, button2, DockingConstants.SPLIT_LEFT);
    desk.split(button2, button3, DockingConstants.SPLIT_BOTTOM);

    // add the fourth button as a tab on the 3rd :
    desk.createTab(button3, button4, 1);

    SwingUtilities.invokeLater(
        new Runnable() {
      public void run() {
        setSize(800,600);
        validate();
        setVisible(true); // realize on the event dispatch thread

      }
    });
  }
  public static void main(String [] args){
    new DemoFrame();
  }

  // our basic dockable object
  class DockableButton extends JButton implements Dockable {
     DockKey key;
     public DockableButton(String label){
        super(label);
        this.key = new DockKey(label); // most simple dockkey constructor
        setPreferredSize(new Dimension(200,200));
     }

    public DockKey getDockKey() {
      return key;
    }

    public Component getComponent() {
      return this;
    }
  }
}
</pre>
<p> But of course, there's more in the docking framework than this.
  For example you can also :
  <ul>
    <li> hide a component on a border
    <li> attract user attention by a blinking dockable title
    <li> adjust the width and height of the dockables
    <li> read and write a desktop configuration from/to an XML stream
    <li> ...
   </ul>
  You can read more about these features in the tutorial on <a href="http://www.vlsolutions.com/en/documention/docking/tutorial">
     www.vlsolutions.com/en/documention/docking/tutorial</a>.

<hr>
<h2> Browsing the API</h2>
<P>The subset of classes of this package needed to understand and use the Docking Framework is
limited to the following classes :</P>
<UL>
<LI> <a href="DockingDesktop.html">DockingPanel</a> : the panel that contains the users components is also the main
interface to docking functions.
<LI> <a href="Dockable.html">Dockable</a> : the interface implemented by dockable objects
<LI> <a href="DockKey.html">DockKey</a> : the key of a Dockable, an object that describes a user component (icon, text, tooltip)
</UL>

<hr>
<h2>Extending the API</h2>
<p>
This API has been developed with extension in mind.
<p>
To Fully understand its principles, you will have to browse the entire javadoc and
read the API extension tutorial on <a href="http://www.vlsolutions.com">www.vlsolutions.com</a>.
<P>

<P>
<DL>
</DL>
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../../com/vlsolutions/swing/docking/animation/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/vlsolutions/swing/docking/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>&copy; Copyright 2004-2006 VLSolutions. All Rights Reserved.
      <br><a href="http://www.vlsolutions.com">www.vlsolutions.com</a> : Java Components - Smart Client Applications</i>
</BODY>
</HTML>
libvldocking-java 2.1.4-4 / usr / share / doc / libvldocking-java / api / com / vlsolutions / swing / docking / package-summary.html
