bibliothek.gui.dock.station.flap

Interface FlapWindow

All Known Implementing Classes:

DefaultFlapWindow

public interface FlapWindow

This window pops up if the user presses one of the buttons of a FlapDockStation. The window shows one Dockable. How exactly to display the Dockable is up to the window.

Method Summary

Modifier and Type	Method and Description
boolean	containsScreenPoint(Point point) Tells whether this window contains point which is a point of the screen.
void	destroy() Informs this window that it is no longer used by its owner and will never be used again.
Component	getComponent() Gets the root Component of this FlapWindow
DockableDisplayer	getDisplayer() Gets the DockableDisplayer which manages the dockable.
Dockable	getDockable() Gets the Dockable which is shown on this window.
Insets	getDockableInsets() Makes a guess how big the insets around the current Dockable of this window are.
DockTitle	getDockTitle() Gets the title which is currently displayed
Rectangle	getWindowBounds() Gets the current boundaries of this window in screen coordinates.
boolean	isWindowVisible() Tells whether this window is shown or hidden.
void	repaint() Tells this window that is should redraw its entire content.
void	setController(DockController controller) Informs this FlapWindow about the DockController in whose realm
void	setDockable(Dockable dockable) Sets the Dockable which will be shown on this window.
void	setDockTitle(DockTitleVersion title) Tells this window how to create a title for any Dockable that may be shown on it.
void	setDropInfo(FlapDropInfo dropInfo) Sets information where a Dockable will be dropped.
void	setRemoval(boolean removal) Tells this window whether a drag and drop operation is currently removing its child.
void	setWindowVisible(boolean flag) Shows or hides this window.
void	updateBounds() Recalculates the size and the location of this window such that it matches the size and location of its parent FlapDockStation.

Method Detail

setWindowVisible

void setWindowVisible(boolean flag)

Shows or hides this window.

Parameters:

flag - whether to show this window

isWindowVisible

boolean isWindowVisible()

Tells whether this window is shown or hidden.

Returns:

true if the window is shown

repaint

void repaint()

Tells this window that is should redraw its entire content.

destroy

void destroy()

Informs this window that it is no longer used by its owner and will never be used again.

getWindowBounds

Rectangle getWindowBounds()

Gets the current boundaries of this window in screen coordinates.

Returns:

the boundaries

containsScreenPoint

boolean containsScreenPoint(Point point)

Tells whether this window contains point which is a point of the screen.

Parameters:

point - a point on the screen

Returns:

true if this window contains point

setDropInfo

void setDropInfo(FlapDropInfo dropInfo)

Sets information where a Dockable will be dropped. This window may draw some markings if the drop-information matches the location of this windows Dockable.

Parameters:

dropInfo - the information or null

setRemoval

void setRemoval(boolean removal)

Tells this window whether a drag and drop operation is currently removing its child.

Parameters:

removal - whether the child of this window is removed

setDockTitle

void setDockTitle(DockTitleVersion title)

Tells this window how to create a title for any Dockable that may be shown on it.

Parameters:

title - the title or null

getDockTitle

DockTitle getDockTitle()

Gets the title which is currently displayed

Returns:

the title or null

setDockable

void setDockable(Dockable dockable)

Sets the Dockable which will be shown on this window.

Parameters:

dockable - The Dockable or null

getDockable

Dockable getDockable()

Gets the Dockable which is shown on this window.

Returns:

The Dockable or null

getDisplayer

DockableDisplayer getDisplayer()

Gets the DockableDisplayer which manages the dockable.

Returns:

the displayer or null

setController

void setController(DockController controller)

Informs this FlapWindow about the DockController in whose realm

Parameters:

controller - the controller or null

getDockableInsets

Insets getDockableInsets()

Makes a guess how big the insets around the current Dockable of this window are.

Returns:

a guess of the insets

updateBounds

void updateBounds()

Recalculates the size and the location of this window such that it matches the size and location of its parent FlapDockStation.

See Also:

FlapDockStation.getWindowSize(Dockable), FlapDockStation.getWindowMinSize(), FlapDockStation.getExpansionBounds()

getComponent

Component getComponent()

Gets the root Component of this FlapWindow

Returns:

the root component, may be null after destroy() was called