Uses of Interface
com.javadocking.dock.Dock

Packages that use Dock
com.javadocking Contains the interfaces and implementations of the Java Docking library. 
com.javadocking.dock Contains the interfaces and implementations for docks. 
com.javadocking.dock.factory Contains the interfaces and implementations for the factories that create new Docks in which Dockables can be docked. 
com.javadocking.drag.dockretriever Contains the functionality for retrieving the Dock, where a Dockable can be docked for a given mouse screen position. 
com.javadocking.drag.painter Contains the functionality for painting a representation of the Dockable, when it is dragged. 
com.javadocking.event Contains the classes for the events that are broadcasted when a dockable or child dock is: added to a dock. 
com.javadocking.model Contains the functionality for dock models and docking path models. 
com.javadocking.util Contains general utility classes. 
com.javadocking.visualizer Contains the interfaces and implementations for Visualizers. 
 

Uses of Dock in com.javadocking
 

Methods in com.javadocking with parameters of type Dock
 boolean DockingExecutor.changeDocking(Dockable dockable, Dock rootDock)
           Tries to dock the dockable in the tree of docks that has the given dock as root dock.
 boolean DockingExecutor.changeDocking(Dockable dockable, Dock destinationDock, java.awt.Point relativeLocation, java.awt.Point dockableOffset)
           Changes the docking of the dockable to the given location in the given destination dock.
 CompositeDock DockingExecutor.cleanDock(Dock dock, boolean ghost)
          The dock is cleaned up, if it is empty.
 

Uses of Dock in com.javadocking.dock
 

Subinterfaces of Dock in com.javadocking.dock
 interface CompositeDock
           This is a Dock that can contain other child docks.
 interface DockableHider
          This is an interface for a leaf dock that can hide an restore one of its dockables.
 interface LeafDock
           This is a dock that contains dockables.
 

Classes in com.javadocking.dock that implement Dock
 class BorderDock
           This is a composite dock that can have one child dock in the center and between zero and 4 child docks at the borders.
 class CompositeGridDock
           This is a composite dock that has child docks that are organized in a grid.
 class CompositeLineDock
           This is a composite dock that has child docks that are organized in a line.
 class FloatDock
           This special dock contains all the floating dockables.
 class GridDock
           This is a dock that can contain zero, one or multiple dockables.
 class LineDock
           This is a dock that can contain zero, one or multiple dockables.
 class SingleDock
           This is a dock that contains zero or one dockables.
 class SplitDock
           This is a composite dock that can contain zero, one, or two child docks.
 class TabDock
           This is a dock that can contain zero, one or multiple dockables.
 

Methods in com.javadocking.dock that return Dock
 Dock CompositeDock.getChildDock(int index)
          Gets the child dock with the specified index.
 Dock CompositeLineDock.getChildDock(int index)
           
 Dock CompositeGridDock.getChildDock(int index)
           
 Dock FloatDock.getChildDock(int index)
           
 Dock BorderDock.getChildDock(int index)
           
 Dock SplitDock.getChildDock(int index)
           
 Dock BorderDock.getChildDockOfPosition(int position)
          Gets the child dock in the given position.
 

Methods in com.javadocking.dock with parameters of type Dock
 void FloatDock.addChildDock(Dock dock, java.awt.Point location, java.awt.Dimension size)
           Adds the given dock as child dock to this dock.
 void CompositeDock.addChildDock(Dock dock, Position position)
           Adds the given dock as child dock at the given position.
 void CompositeLineDock.addChildDock(Dock dock, Position position)
           
 void CompositeGridDock.addChildDock(Dock dock, Position position)
           
 void FloatDock.addChildDock(Dock dock, Position position)
          Adds the child dock to the given position.
 void BorderDock.addChildDock(Dock dock, Position position)
           Sets the given dock as child dock of this dock in the given position.
 void SplitDock.addChildDock(Dock dockToAdd, Position position)
           
 void CompositeDock.emptyChild(Dock childDock)
          Is called when the specified child dock is empty.
 void CompositeLineDock.emptyChild(Dock emptyChildDock)
           
 void CompositeGridDock.emptyChild(Dock emptyChildDock)
           
 void FloatDock.emptyChild(Dock childDock)
           
 void BorderDock.emptyChild(Dock emptyChildDock)
           
 void SplitDock.emptyChild(Dock emptyChildDock)
           
 Position CompositeDock.getChildDockPosition(Dock childDock)
          Gets the position, where the child dock is docked in this dock.
 Position CompositeLineDock.getChildDockPosition(Dock childDock)
           
 Position CompositeGridDock.getChildDockPosition(Dock childDock)
           
 Position FloatDock.getChildDockPosition(Dock childDock)
           
 Position BorderDock.getChildDockPosition(Dock childDock)
           
 Position SplitDock.getChildDockPosition(Dock childDock)
           
 void CompositeDock.ghostChild(Dock childDock)
          Makes the given empty child dock invisible.
 void CompositeLineDock.ghostChild(Dock emptyChildDock)
           
 void CompositeGridDock.ghostChild(Dock emptyChildDock)
           
 void FloatDock.ghostChild(Dock childDock)
           
 void BorderDock.ghostChild(Dock childDock)
           
 void SplitDock.ghostChild(Dock childDock)
           
 void FloatDock.moveDock(Dock childDock, java.awt.Point relativeLocation, java.awt.Point dockableOffset)
          Moves the given child dock to the new location.
 void BorderDock.setDock(Dock dock, int position)
          Sets the given dock as child dock of this dock in the given position.
 void SplitDock.setSingleChildDock(Dock dock)
          Sets the given dock as single child dock of this dock.
 

Constructors in com.javadocking.dock with parameters of type Dock
BorderDock(Dock centerChildDock)
          Constructs a border dock with a given child dock for in the center and a LeafDockFactory as factory for the child docks.
BorderDock(DockFactory childDockFactory, Dock centerChildDock)
          Constructs a border dock with the given factory for creating the child docks at the borders and a given child dock for in the center.
 

Uses of Dock in com.javadocking.dock.factory
 

Methods in com.javadocking.dock.factory that return Dock
 Dock ToolBarDockFactory.createDock(Dockable dockable, int dockingMode)
          Creates a tool bar dock.
 Dock TabDockFactory.createDock(Dockable dockable, int dockingMode)
           
 Dock SplitDockFactory.createDock(Dockable dockable, int dockingMode)
           
 Dock SingleDockFactory.createDock(Dockable dockable, int dockingMode)
           
 Dock LeafDockFactory.createDock(Dockable dockable, int dockingMode)
           
 Dock DockFactory.createDock(Dockable dockable, int dockingMode)
          Creates a dock for the given dockable.
 Dock CompositeToolBarDockFactory.createDock(Dockable dockable, int dockingMode)
          Creates a composite tool bar dock.
 

Uses of Dock in com.javadocking.drag.dockretriever
 

Methods in com.javadocking.drag.dockretriever that return Dock
 Dock[] StaticDockRetriever.retrieveHighestPriorityDock(java.awt.Point screenLocation, Dockable dockable)
           
 Dock[] DynamicDockRetriever.retrieveHighestPriorityDock(java.awt.Point screenLocation, Dockable dockable)
           
 Dock[] DockRetriever.retrieveHighestPriorityDock(java.awt.Point screenLocation, Dockable dockable)
          Retrieves the dock that has the highest priority for adding the dockable, when the dockable is dragged over the given screen location.
 

Uses of Dock in com.javadocking.drag.painter
 

Methods in com.javadocking.drag.painter with parameters of type Dock
 java.awt.Component RectangleDragComponentFactory.createDragComponent(Dockable dockable, Dock dock, java.awt.Rectangle rectangle)
           
 java.awt.Component DragComponentFactory.createDragComponent(Dockable dockable, Dock dock, java.awt.Rectangle rectangle)
          Creates a component to show where a dockable will be docked in a dock while dragging the dockable.
 void ImageDockableDragPainter.paintDockableDrag(Dockable newDockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void WindowDockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void TransparentWindowDockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void SwDockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void OldWindowDockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void LabelDockableDragPainter.paintDockableDrag(Dockable newDockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 void DockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point mouseLocation)
           Paints a dockable during dragging.
 void CompositeDockableDragPainter.paintDockableDrag(Dockable dockable, Dock dock, java.awt.Rectangle rectangle, java.awt.Point locationInDestinationDock)
           
 

Uses of Dock in com.javadocking.event
 

Methods in com.javadocking.event that return Dock
 Dock ChildDockEvent.getChildDock()
          Gets the child dock that is added, moved, or removed.
 Dock DockingEvent.getDestinationDock()
          Gets the dock to which the dockable or child dock is added or moved.
 Dock DockingEvent.getOriginDock()
          Gets the dock from which the dockable or child dock is removed or moved.
 

Constructors in com.javadocking.event with parameters of type Dock
ChildDockEvent(java.lang.Object source, CompositeDock originDock, CompositeDock destinationDock, Dock childDock)
          Constructs a docking event for the given composite dock and child dock.
DockableEvent(java.lang.Object source, Dock originDock, Dock destinationDock, Dockable dockable)
          Constructs a docking event for the given dock and dockable.
DockingEvent(java.lang.Object source, Dock originDock, Dock destinationDock)
          Constructs a docking event for the given dock.
 

Uses of Dock in com.javadocking.model
 

Methods in com.javadocking.model that return Dock
 Dock DefaultDockingPath.getDock(int index)
           
 Dock DockingPath.getDock(int index)
           Gets the dock with the given index in the path.
 Dock DefaultDockModel.getRootDock(java.lang.String rootKey)
           
 Dock DockModel.getRootDock(java.lang.String rootKey)
          Gets the root dock of this dock model that has the given key associated to it.
 

Methods in com.javadocking.model with parameters of type Dock
 void DefaultDockModel.addRootDock(java.lang.String rootKey, Dock dock, java.awt.Window owner)
           
 void FloatDockModel.addRootDock(java.lang.String rootKey, Dock dock, java.awt.Window owner)
          Checks that the appropriate key is used (FloatDockModel.getFloatDockKey(Window)), when the root dock is a FloatDock.
 void DockModel.addRootDock(java.lang.String rootKey, Dock dock, java.awt.Window owner)
          Adds a root dock with its key to this dock model.
 void DefaultDockModel.removeRootDock(Dock dock)
           
 void DockModel.removeRootDock(Dock dock)
          Removes the root dock from the dock model.
 

Constructors in com.javadocking.model with parameters of type Dock
DefaultDockingPath(java.lang.String id, java.lang.String rootDockKey, Dock[] docks, Position[] positions)
          Constructs a docking path with the given properties.
 

Uses of Dock in com.javadocking.util
 

Methods in com.javadocking.util that return Dock
static Dock DockingUtil.getFloatChildDock(Dock dock)
          Searches the ancestor of the given dock that is the child of the root FloatDock.
static Dock DockingUtil.getRootDock(Dock dock)
          Gets the root dock of the dock tree that contains the given dock.
static Dock DockingUtil.searchDock(Dock rootDock, Dockable dockable)
          Tries to find the dock that contains the given dockable in the dock tree with the given dock as root.
 

Methods in com.javadocking.util with parameters of type Dock
static boolean DockingUtil.containsDock(Dock rootDock, Dock dock)
          Tries to find the dock in the dock tree with the given dock as root.
static Dockable DockingUtil.createDockable(Dock dock)
           Creates one dockable with the dockables of a dock.
static Dock DockingUtil.getFloatChildDock(Dock dock)
          Searches the ancestor of the given dock that is the child of the root FloatDock.
static Dock DockingUtil.getRootDock(Dock dock)
          Gets the root dock of the dock tree that contains the given dock.
static java.lang.String DockingUtil.getRootDockKey(Dock rootDock)
          Gets the key of the given root dock in the dock model of the docking manager.
static void DockingUtil.retrieveDockables(Dock rootDock, java.util.List dockables)
          Retrieves the dockables that are contained by all the docks that are in the dock tree with the given dock as root dock.
static Dock DockingUtil.searchDock(Dock rootDock, Dockable dockable)
          Tries to find the dock that contains the given dockable in the dock tree with the given dock as root.
 

Uses of Dock in com.javadocking.visualizer
 

Subinterfaces of Dock in com.javadocking.visualizer
 interface ExternalizeDock
          This is an interface for a leaf dock that can contain an externalized dockable.