bibliothek.gui.dock.station.screen.window
Interface ScreenDockWindowBorder

All Superinterfaces:
Border
All Known Implementing Classes:
DefaultScreenDockWindowBorder

public interface ScreenDockWindowBorder
extends Border

This border can be used by ScreenDockWindows to paint a border. The border itself may offer methods to paint indications whether the user currently moves or presses the mouse over it. The states will be set by the window itself.

Author:
Benjamin Sigg

Nested Class Summary
static class ScreenDockWindowBorder.Position
          various positions where the user can grab this border
 
Method Summary
 void setController(DockController controller)
          Sets the DockController which should be monitored for receiving colors.
 void setCornerSize(int cornerSize)
          Sets the size of the corners in pixels.
 void setMouseOver(ScreenDockWindowBorder.Position mouseOver)
          Sets where the mouse is currently hovering.
 void setMousePressed(ScreenDockWindowBorder.Position mousePressed)
          Sets where the mouse is currently pressed.
 void setMoveable(boolean moveable)
          Informs this border whether the window can be moved by grabbing this.
 void setMoveSize(int moveSize)
          Sets the size of the area at the top that can be grabbed and used to move the window.
This property is only important if the window is moveable, otherwise it can be ignored.
 void setResizeable(boolean resizeable)
          Informs this border whether the window can be resized by grabbing this.
 
Methods inherited from interface javax.swing.border.Border
getBorderInsets, isBorderOpaque, paintBorder
 

Method Detail

setController

void setController(DockController controller)
Sets the DockController which should be monitored for receiving colors.

Parameters:
controller - the new controller, can be null

setMousePressed

void setMousePressed(ScreenDockWindowBorder.Position mousePressed)
Sets where the mouse is currently pressed.

Parameters:
mousePressed - the position, null equals ScreenDockWindowBorder.Position.NOTHING

setMouseOver

void setMouseOver(ScreenDockWindowBorder.Position mouseOver)
Sets where the mouse is currently hovering.

Parameters:
mouseOver - the position, null equals ScreenDockWindowBorder.Position.NOTHING

setCornerSize

void setCornerSize(int cornerSize)
Sets the size of the corners in pixels. If the mouse is in a corner, then the window can be resized in two dimensions.
This property is only important if the window is resizeable, otherwise it can be ignored

Parameters:
cornerSize - the size in pixels, at least 0

setMoveSize

void setMoveSize(int moveSize)
Sets the size of the area at the top that can be grabbed and used to move the window.
This property is only important if the window is moveable, otherwise it can be ignored.

Parameters:
moveSize - the size, at least 0

setMoveable

void setMoveable(boolean moveable)
Informs this border whether the window can be moved by grabbing this.

Parameters:
moveable - whether the window can be moved

setResizeable

void setResizeable(boolean resizeable)
Informs this border whether the window can be resized by grabbing this.

Parameters:
resizeable - whether the window can be resized