bibliothek.gui.dock.station.toolbar.menu

Interface CustomizationMenuCallback

All Known Implementing Classes:

CustomizationButton.Button

public interface CustomizationMenuCallback

This callback is delivered to a CustomizationMenu, it allows the menu to communicate with its parent DockStation.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	append(Dockable dockable) Adds dockable to the station or one of its sub stations.
void	closed() To be called if the menu was closed.
Rectangle	getButton() Gets the boundaries of the button that opened this menu.
DockStation	getOwner() Gets the owner of the menu.
Component	getParent() Gets the parent Component of the menu, this Component can be used for example as parent of a JDialog.
boolean	isAutoCloseAllowed() Tells the menu whether it is currently allowed to close itself automatically.

Method Detail

getButton

Rectangle getButton()

Gets the boundaries of the button that opened this menu. The button should remain visible.

Returns:

the location of the button, may be null

getParent

Component getParent()

Gets the parent Component of the menu, this Component can be used for example as parent of a JDialog.

Returns:

the parent Component, not null

getOwner

DockStation getOwner()

Gets the owner of the menu.

Returns:

the owner, not null

append

void append(Dockable dockable)

Adds dockable to the station or one of its sub stations.

Parameters:

dockable - the item to add

isAutoCloseAllowed

boolean isAutoCloseAllowed()

Tells the menu whether it is currently allowed to close itself automatically.

Returns:

whether the menu is allowed to close itself

closed

void closed()

To be called if the menu was closed.