Docker (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.util.Docker

All Implemented Interfaces:

ComponentListener, EventListener
```
public class Docker
extends Object
implements ComponentListener
```
This class is used to specify a group of windows able to be docked to one another. When a window is moved close enough to another window, it snaps next to it, becoming docked. When the nearby window is subsequently moved, it drags all docked windows along with it. Docker also enables windows to snap to the edges of the screen, if desired.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PRIORITY` Default window docking priority.
`protected Vector`	`docked` For each window, the set of windows docked to it.
`protected boolean`	`edges` Whether to snap to the edges of the screen.
`protected boolean`	`enabled` Whether to perform docking operations at all.
`static int`	`HIGH_PRIORITY` A docking priority higher than the default.
`protected Vector`	`locations` List of window locations.
`static int`	`LOW_PRIORITY` A docking priority lower than the default.
`protected Vector`	`priorities` List of window docking priorities.
`protected int`	`thresh` Pixel threshold for windows to snap next to one another.
`protected Vector`	`windows` List of windows able to be docked to one another.

Constructor Summary

Constructors
Constructor and Description

Docker()

Constructors
Constructor and Description
`Docker()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static int`	`abs(int value)` Integer absolute value function.
`void`	`addWindow(Window w)` Adds a window to the dockable group.
`void`	`addWindow(Window w, int priority)` Adds a window to the dockable group, at the given docking priority.
`protected void`	`buildGroup(int ndx, Vector group)` Recursively builds a list of windows docked together into a group.
`void`	`componentHidden(ComponentEvent e)` Called when a window is hidden.
`void`	`componentMoved(ComponentEvent e)` Called when a window is moved.
`void`	`componentResized(ComponentEvent e)` Called when a window is resized.
`void`	`componentShown(ComponentEvent e)` Called when a window is shown.
`protected Point`	`computeDistance(Rectangle a, Rectangle b)` Computes the distance rectangle A must snap to adjoin rectangle B.
`protected Point`	`computeDistance(Window a, Window b)` Computes the distance window A must snap to adjoin window B.
`protected Point`	`computeSnap(Window w, Vector non)` Computes the X and Y distances the docked group should snap.
`protected void`	`dock(Window a, Window b)` Docks window A to window B.
`protected HashSet`	`getDockSet(int ndx)` Gets the set of docked windows for the window at the specified index.
`protected HashSet`	`getDockSet(Window w)` Gets the set of docked windows for the given window.
`protected int`	`getIndex(Window w)` Gets the given window's index.
`protected Point`	`getLocation(int ndx)` Gets the last recorded location of the window at the specified index.
`protected Point`	`getLocation(Window w)` Gets the given window's last recorded location.
`protected int`	`getPriority(int ndx)` Gets the docking priority for the window at the specified index.
`protected int`	`getPriority(Window w)` Gets the docking priority for the given window.
`protected Window`	`getWindow(int ndx)` Gets the window at the specified index.
`static void`	`main(String[] args)` Tests the Docker class.
`void`	`removeAllWindows()` Removes all windows from the dockable group.
`void`	`removeWindow(Window w)` Removes a window from the dockable group.
`void`	`setEnabled(boolean enabled)` Sets whether docker should perform docking operations.
`void`	`setSnapThreshold(int pixels)` Sets the docking threshold in pixels.
`void`	`setSnapToScreenEdges(boolean snap)` Sets whether windows should snap to the screen edges when close.
`protected void`	`shiftLocation(Window w, int px, int py)` Shifts the given window's location by the given amount, without generating a ComponentEvent.
`protected void`	`undock(Window a, Window b)` Undocks window A from window B.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PRIORITY
```
public static final int DEFAULT_PRIORITY
```
    Default window docking priority.
    
    See Also:
    
    Constant Field Values
  - LOW_PRIORITY
```
public static final int LOW_PRIORITY
```
    A docking priority lower than the default.
    
    See Also:
    
    Constant Field Values
  - HIGH_PRIORITY
```
public static final int HIGH_PRIORITY
```
    A docking priority higher than the default.
    
    See Also:
    
    Constant Field Values
  - windows
```
protected Vector windows
```
    List of windows able to be docked to one another.
  - locations
```
protected Vector locations
```
    List of window locations.
  - docked
```
protected Vector docked
```
    For each window, the set of windows docked to it.
  - priorities
```
protected Vector priorities
```
    List of window docking priorities.
  - enabled
```
protected boolean enabled
```
    Whether to perform docking operations at all.
  - thresh
```
protected int thresh
```
    Pixel threshold for windows to snap next to one another.
  - edges
```
protected boolean edges
```
    Whether to snap to the edges of the screen.
- Constructor Detail
  - Docker
```
public Docker()
```
- Method Detail
  - addWindow
```
public void addWindow(Window w)
```
    Adds a window to the dockable group.
  - addWindow
```
public void addWindow(Window w,
                      int priority)
```
    Adds a window to the dockable group, at the given docking priority.
  - removeWindow
```
public void removeWindow(Window w)
```
    Removes a window from the dockable group.
  - removeAllWindows
```
public void removeAllWindows()
```
    Removes all windows from the dockable group.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether docker should perform docking operations.
  - setSnapThreshold
```
public void setSnapThreshold(int pixels)
```
    Sets the docking threshold in pixels.
  - setSnapToScreenEdges
```
public void setSnapToScreenEdges(boolean snap)
```
    Sets whether windows should snap to the screen edges when close.
  - componentResized
```
public void componentResized(ComponentEvent e)
```
    Called when a window is resized.
    
    Specified by:
    
    componentResized in interface ComponentListener
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
    Called when a window is moved.
    
    Specified by:
    
    componentMoved in interface ComponentListener
  - componentShown
```
public void componentShown(ComponentEvent e)
```
    Called when a window is shown.
    
    Specified by:
    
    componentShown in interface ComponentListener
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
    Called when a window is hidden.
    
    Specified by:
    
    componentHidden in interface ComponentListener
  - getWindow
```
protected Window getWindow(int ndx)
```
    Gets the window at the specified index.
  - getLocation
```
protected Point getLocation(int ndx)
```
    Gets the last recorded location of the window at the specified index.
  - getDockSet
```
protected HashSet getDockSet(int ndx)
```
    Gets the set of docked windows for the window at the specified index.
  - getPriority
```
protected int getPriority(int ndx)
```
    Gets the docking priority for the window at the specified index.
  - getIndex
```
protected int getIndex(Window w)
```
    Gets the given window's index.
  - getLocation
```
protected Point getLocation(Window w)
```
    Gets the given window's last recorded location.
  - getDockSet
```
protected HashSet getDockSet(Window w)
```
    Gets the set of docked windows for the given window.
  - getPriority
```
protected int getPriority(Window w)
```
    Gets the docking priority for the given window.
  - dock
```
protected void dock(Window a,
                    Window b)
```
    Docks window A to window B.
  - undock
```
protected void undock(Window a,
                      Window b)
```
    Undocks window A from window B.
  - abs
```
protected static int abs(int value)
```
    Integer absolute value function.
  - computeDistance
```
protected Point computeDistance(Rectangle a,
                                Rectangle b)
```
    Computes the distance rectangle A must snap to adjoin rectangle B.
  - computeDistance
```
protected Point computeDistance(Window a,
                                Window b)
```
    Computes the distance window A must snap to adjoin window B.
  - computeSnap
```
protected Point computeSnap(Window w,
                            Vector non)
```
    Computes the X and Y distances the docked group should snap.
  - shiftLocation
```
protected void shiftLocation(Window w,
                             int px,
                             int py)
```
    Shifts the given window's location by the given amount, without generating a ComponentEvent.
  - buildGroup
```
protected void buildGroup(int ndx,
                          Vector group)
```
    Recursively builds a list of windows docked together into a group.
  - main
```
public static void main(String[] args)
```
    Tests the Docker class.

Class Docker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PRIORITY

LOW_PRIORITY

HIGH_PRIORITY

windows

locations

docked

priorities

enabled

thresh

edges

Constructor Detail

Docker

Method Detail

addWindow

addWindow

removeWindow

removeAllWindows

setEnabled

setSnapThreshold

setSnapToScreenEdges

componentResized

componentMoved

componentShown

componentHidden

getWindow

getLocation

getDockSet

getPriority

getIndex

getLocation

getDockSet

getPriority

dock

undock

abs

computeDistance

computeDistance

computeSnap

shiftLocation

buildGroup

main