bibliothek.gui.dock.station.screen

Class ScreenDockStationExtension.DropArguments

java.lang.Object

bibliothek.gui.dock.station.screen.ScreenDockStationExtension.DropArguments

Enclosing interface:

ScreenDockStationExtension

public static class ScreenDockStationExtension.DropArguments
extends Object

A class offering all the arguments of the method ScreenDockStation.drop(Dockable, ScreenDockProperty, boolean)

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
DropArguments()

Method Summary

Modifier and Type	Method and Description
Dockable	getDockable() Gets the element which is about to be dropped
ScreenDockProperty	getProperty() Gets the location at which the element will be dropped
ScreenDockWindow	getWindow() Gets the window with which the element will be merged
boolean	isBoundsIncludeWindow() If true, the bounds describe the size of the resulting window.
void	setBoundsIncludeWindow(boolean boundsIncludeWindow) Sets whether the boundaries of the location include the entire window.
void	setDockable(Dockable dockable) Sets the dockable which is to be dropped.
void	setProperty(ScreenDockProperty property) Sets the location at which the element is to be dropped.
void	setWindow(ScreenDockWindow window) Sets the window with which the element will be merged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DropArguments

public DropArguments()

Method Detail

setDockable

public void setDockable(Dockable dockable)

Sets the dockable which is to be dropped.

Parameters:

dockable - the dockable, must not be null

getDockable

public Dockable getDockable()

Gets the element which is about to be dropped

Returns:

the element to drop

setProperty

public void setProperty(ScreenDockProperty property)

Sets the location at which the element is to be dropped.

Parameters:

property - the new location at which to drop the element, not null

getProperty

public ScreenDockProperty getProperty()

Gets the location at which the element will be dropped

Returns:

the location, not null

setBoundsIncludeWindow

public void setBoundsIncludeWindow(boolean boundsIncludeWindow)

Sets whether the boundaries of the location include the entire window.

Parameters:

boundsIncludeWindow - whether the entire window is included

See Also:

isBoundsIncludeWindow()

isBoundsIncludeWindow

public boolean isBoundsIncludeWindow()

If true, the bounds describe the size of the resulting window. Otherwise the size of the window will be a bit larger such that the title can be shown in the new space

Returns:

whether the bounds include the window

setWindow

public void setWindow(ScreenDockWindow window)

Sets the window with which the element will be merged

Parameters:

window - the merging window, can be null

getWindow

public ScreenDockWindow getWindow()

Gets the window with which the element will be merged

Returns:

the merging window