bibliothek.gui.dock.station.screen.layer
Class ScreenWindowLayer

java.lang.Object
  extended by bibliothek.gui.dock.station.layer.DefaultDropLayer
      extended by bibliothek.gui.dock.station.screen.layer.ScreenWindowLayer
All Implemented Interfaces:
DockStationDropLayer

public class ScreenWindowLayer
extends DefaultDropLayer

Describes a layer where one ScreenDockWindow resides.

Author:
Benjamin Sigg

Constructor Summary
ScreenWindowLayer(ScreenDockStation station, ScreenDockWindow window)
           
 
Method Summary
 boolean contains(int x, int y)
          Tells whether this level contains the point x/y, which is the position of the mouse on the screen.
 Component getComponent()
          Gets a Component which is associated with this level.
 DockStationDropLayer modify(DockStationDropLayer child)
          This method is called for any DockStationDropLayer whose station is a child to the station of this level.
 
Methods inherited from class bibliothek.gui.dock.station.layer.DefaultDropLayer
canCompare, compare, getPriority, getStation, setPriority
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScreenWindowLayer

public ScreenWindowLayer(ScreenDockStation station,
                         ScreenDockWindow window)
Method Detail

contains

public boolean contains(int x,
                        int y)
Description copied from interface: DockStationDropLayer
Tells whether this level contains the point x/y, which is the position of the mouse on the screen.

Specified by:
contains in interface DockStationDropLayer
Overrides:
contains in class DefaultDropLayer
Parameters:
x - the x-coordinate of the mouse on the screen
y - the y-coordinate of the mouse on the screen
Returns:
true if this level contains x/y, false otherwise

getComponent

public Component getComponent()
Description copied from interface: DockStationDropLayer
Gets a Component which is associated with this level. The Component can be used to order levels because Components can overlap each other. This is an optional method, a result of null is perfectly valid.

Specified by:
getComponent in interface DockStationDropLayer
Overrides:
getComponent in class DefaultDropLayer
Returns:
some component or null

modify

public DockStationDropLayer modify(DockStationDropLayer child)
Description copied from interface: DockStationDropLayer
This method is called for any DockStationDropLayer whose station is a child to the station of this level. This method may modify the level, e.g. increase or decrease its priority. This method is called before this level itself gets modified by its parents. This method is called independent of whether DockStationDropLayer.contains(int, int) returns true or false.

Specified by:
modify in interface DockStationDropLayer
Overrides:
modify in class DefaultDropLayer
Parameters:
child - the child to modify, this method may either directly modify child, create a wrapper or a copy of child
Returns:
either child or a new DockStationDropLayer replacing child, not null