## com.bbn.openmap.gui.dock
Interface DockPanel

All Known Implementing Classes:
  BasicDockPanel, DockMapPanel

public interface DockPanel

An interface onto a component that has a background component and docking children.

Since:
  12/5/02
Version:
  $Revision: 1.4.2.1 $ on $Date: 2004/10/14 18:26:55 $
Author:
  Ben Lubin

Field Summary
`static java.lang.String` `BACKGROUND` Constraint for the background component

Method Summary
`void` `dock(javax.swing.JComponent outter, javax.swing.JComponent inner)` Dock the given child onto the given parent, which is itself a child.
`void` `dock(javax.swing.JComponent outter, javax.swing.JComponent inner, int idx)` Dock the given child onto the given parent, which is itself a child.
`void` `dockEast(javax.swing.JComponent child)` Dock child on the DockPanel.
`void` `dockEast(javax.swing.JComponent child, int idx)` Dock the given child into the given position on the DockPanel
`void` `dockNorth(javax.swing.JComponent child)` Dock child on the DockPanel.
`void` `dockNorth(javax.swing.JComponent child, int idx)` Dock the given child into the given position on the DockPanel
`void` `dockSomewhere(javax.swing.JComponent child)` Dock the given child somewhere on the DockPanel.
`void` `dockSouth(javax.swing.JComponent child)` Dock child on the DockPanel.
`void` `dockSouth(javax.swing.JComponent child, int idx)` Dock the given child into the given position on the DockPanel
`void` `dockWest(javax.swing.JComponent child)` Dock child on the DockPanel.
`void` `dockWest(javax.swing.JComponent child, int idx)` Dock the given child into the given position on the DockPanel
`void` `externalFrame(javax.swing.JComponent child)` Set the component to an external frame
`javax.swing.JComponent` `getBackgroundComponent()` Get the background component.
`DockConstraint` `getConstraint(javax.swing.JComponent child)` Get the constraint on the given child.
`void` `internalFrame(javax.swing.JComponent child)` Set the component to an internal frame
`void` `removeConstraint(javax.swing.JComponent child)` Remove a constraint on a child.
`void` `setBackgroundComponent(javax.swing.JComponent back)` Set the background component.
`void` `setCanClose(javax.swing.JComponent child, boolean b)` Set that the child can be closed.
`void` `setCanDockEast(javax.swing.JComponent child, boolean b)` Set that the child can dock on the top-level east.
`void` `setCanDockNorth(javax.swing.JComponent child, boolean b)` Set that the child can dock on the top-level north.
`void` `setCanDockSouth(javax.swing.JComponent child, boolean b)` Set that the child can dock on the top-level south.
`void` `setCanDockWest(javax.swing.JComponent child, boolean b)` Set that the child can dock on the top-level west.
`void` `setCanExternalFrame(javax.swing.JComponent child, boolean b)` Set that the child can be become an external frame.
`void` `setCanInternalFrame(javax.swing.JComponent child, boolean b)` Set that the child can be become an internal frame.
`void` `setCanOcclude(javax.swing.JComponent child, boolean b)` Set that the given child can sit in front of the background component, without forcing the background component to be resized to make room.
`void` `setCanResize(javax.swing.JComponent child, boolean b)` Set that the child component can be user-resized.
`void` `setCanTab(javax.swing.JComponent child, boolean b)` Set that the child component can be tabbed up, if docked in the same location as othe tab-able components.
`void` `setCanTransparent(javax.swing.JComponent child, boolean b)` Set the child component to have a transparent background.
`void` `setConstraint(javax.swing.JComponent child, DockConstraint c)` Set the constraint on the given child.
`void` `setPreferredHeight(javax.swing.JComponent child, int i)` Set the childs preferred height.
`void` `setPreferredWidth(javax.swing.JComponent child, int i)` Set the childs preferred width.
`void` `setTabName(javax.swing.JComponent child, java.lang.String tabName)` Set the name of the tab to use when the component is tabbed (if it can tab).

Field Detail

### BACKGROUND

    public static final java.lang.String BACKGROUND

  Constraint for the background component

  See Also:
    Constant Field Values

Method Detail

### getBackgroundComponent

    public javax.swing.JComponent getBackgroundComponent()

  Get the background component.

### setBackgroundComponent

    public void setBackgroundComponent(javax.swing.JComponent back)

  Set the background component.

### setConstraint

    public void setConstraint(javax.swing.JComponent child,
                              DockConstraint c)

  Set the constraint on the given child.

### getConstraint

    public DockConstraint getConstraint(javax.swing.JComponent child)

  Get the constraint on the given child.

### removeConstraint

    public void removeConstraint(javax.swing.JComponent child)

  Remove a constraint on a child.

### setPreferredHeight

    public void setPreferredHeight(javax.swing.JComponent child,
                                   int i)

  Set the childs preferred height.

### setPreferredWidth

    public void setPreferredWidth(javax.swing.JComponent child,
                                  int i)

  Set the childs preferred width.

### setCanOcclude

    public void setCanOcclude(javax.swing.JComponent child,
                              boolean b)

  Set that the given child can sit in front of the background component, without forcing the background component to be resized to make room.

### setCanTransparent

    public void setCanTransparent(javax.swing.JComponent child,
                                  boolean b)

  Set the child component to have a transparent background.

### setCanResize

    public void setCanResize(javax.swing.JComponent child,
                             boolean b)

  Set that the child component can be user-resized.

### setCanTab

    public void setCanTab(javax.swing.JComponent child,
                          boolean b)

  Set that the child component can be tabbed up, if docked in the same location as othe tab-able components.

### setTabName

    public void setTabName(javax.swing.JComponent child,
                           java.lang.String tabName)

  Set the name of the tab to use when the component is tabbed (if it can tab). If unspecified, defaults to Component.getName()

### setCanExternalFrame

    public void setCanExternalFrame(javax.swing.JComponent child,
                                    boolean b)

  Set that the child can be become an external frame.

### setCanInternalFrame

    public void setCanInternalFrame(javax.swing.JComponent child,
                                    boolean b)

  Set that the child can be become an internal frame.

### setCanClose

    public void setCanClose(javax.swing.JComponent child,
                            boolean b)

  Set that the child can be closed.

### setCanDockNorth

    public void setCanDockNorth(javax.swing.JComponent child,
                                boolean b)

  Set that the child can dock on the top-level north.

### setCanDockSouth

    public void setCanDockSouth(javax.swing.JComponent child,
                                boolean b)

  Set that the child can dock on the top-level south.

### setCanDockEast

    public void setCanDockEast(javax.swing.JComponent child,
                               boolean b)

  Set that the child can dock on the top-level east.

### setCanDockWest

    public void setCanDockWest(javax.swing.JComponent child,
                               boolean b)

  Set that the child can dock on the top-level west.

### dockNorth

    public void dockNorth(javax.swing.JComponent child)

  Dock child on the DockPanel.

### dockNorth

    public void dockNorth(javax.swing.JComponent child,
                          int idx)

  Dock the given child into the given position on the DockPanel

### dockSouth

    public void dockSouth(javax.swing.JComponent child)

  Dock child on the DockPanel.

### dockSouth

    public void dockSouth(javax.swing.JComponent child,
                          int idx)

  Dock the given child into the given position on the DockPanel

### dockEast

    public void dockEast(javax.swing.JComponent child)

  Dock child on the DockPanel.

### dockEast

    public void dockEast(javax.swing.JComponent child,
                         int idx)

  Dock the given child into the given position on the DockPanel

### dockWest

    public void dockWest(javax.swing.JComponent child)

  Dock child on the DockPanel.

### dockWest

    public void dockWest(javax.swing.JComponent child,
                         int idx)

  Dock the given child into the given position on the DockPanel

### dockSomewhere

    public void dockSomewhere(javax.swing.JComponent child)

  Dock the given child somewhere on the DockPanel.

### dock

    public void dock(javax.swing.JComponent outter,
                     javax.swing.JComponent inner)

  Dock the given child onto the given parent, which is itself a child.

### dock

    public void dock(javax.swing.JComponent outter,
                     javax.swing.JComponent inner,
                     int idx)

  Dock the given child onto the given parent, which is itself a child.

### internalFrame

    public void internalFrame(javax.swing.JComponent child)

  Set the component to an internal frame

### externalFrame

    public void externalFrame(javax.swing.JComponent child)

  Set the component to an external frame

Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details