bibliothek.gui.dock.frontend

Interface DockFrontendInternals

public interface DockFrontendInternals

A set of data and methods that may be exclusively used while changing the layout of a DockFrontend.

Author:

Benjamin Sigg

Method Summary

Modifier and Type	Method and Description
void	clean(DockSituationIgnore ignore) Removes all child-parent relations expect the ones filtered out by ignore.
AdjacentDockFactory<?>[]	getAdjacentDockFactories() Gets a list of all AdjacentDockFactorys that were added using DockFrontend.registerAdjacentFactory(AdjacentDockFactory).
DockFactory<?,?,?>[]	getBackupDockFactories() Gets a list of all DockFactorys that were added using DockFrontend.registerBackupFactory(DockFactory).
DockFrontend.DockInfo[]	getDockables() Gets information about all the Dockables that are registered.
DockFactory<?,?,?>[]	getDockFactories() Gets a list of all DockFactorys that were added using DockFrontend.registerFactory(DockFactory).
DockFrontend	getFrontend() The frontend that grants this permissions.
DockFrontend.DockInfo	getInfo(Dockable dockable) Searches information about dockable.
DockFrontend.DockInfo	getInfo(String key) Searches for information about the Dockable with unique identifier key.
MissingDockableStrategy	getMissingDockableStrategy() Gets information how to handle cases where information about a Dockable is found but the dockable itself is missing.
DockablePropertyFactory[]	getPropertyFactories() Gets a list of all AdjacentDockFactorys that were added using DockFrontend.registerFactory(DockablePropertyFactory).
DockFrontend.RootInfo[]	getRoots() Gets information about all the roots that are registered.
VetoManager	getVetos() Allows access to all the VetoableDockFrontendListeners for questioning about some operations.

Method Detail

getFrontend

DockFrontend getFrontend()

The frontend that grants this permissions.

Returns:

the source of this permissions

clean

void clean(DockSituationIgnore ignore)

Removes all child-parent relations expect the ones filtered out by ignore.

Parameters:

ignore - a filter, never null

getRoots

DockFrontend.RootInfo[] getRoots()

Gets information about all the roots that are registered.

Returns:

all the roots

getDockables

DockFrontend.DockInfo[] getDockables()

Gets information about all the Dockables that are registered.

Returns:

all the dockables

getInfo

DockFrontend.DockInfo getInfo(String key)

Searches for information about the Dockable with unique identifier key.

Parameters:

key - the name of some element

Returns:

information or null if nothing was found

getInfo

DockFrontend.DockInfo getInfo(Dockable dockable)

Searches information about dockable.

Parameters:

dockable - some dockable to search

Returns:

information or null if nothing was found

getDockFactories

DockFactory<?,?,?>[] getDockFactories()

Gets a list of all DockFactorys that were added using DockFrontend.registerFactory(DockFactory).

Returns:

all the factories

getBackupDockFactories

DockFactory<?,?,?>[] getBackupDockFactories()

Gets a list of all DockFactorys that were added using DockFrontend.registerBackupFactory(DockFactory).

Returns:

all the factories

getAdjacentDockFactories

AdjacentDockFactory<?>[] getAdjacentDockFactories()

Gets a list of all AdjacentDockFactorys that were added using DockFrontend.registerAdjacentFactory(AdjacentDockFactory).

Returns:

all the factories

getPropertyFactories

DockablePropertyFactory[] getPropertyFactories()

Gets a list of all AdjacentDockFactorys that were added using DockFrontend.registerFactory(DockablePropertyFactory).

Returns:

all the factories

getMissingDockableStrategy

MissingDockableStrategy getMissingDockableStrategy()

Gets information how to handle cases where information about a Dockable is found but the dockable itself is missing.

Returns:

the strategy, not null

getVetos

VetoManager getVetos()

Allows access to all the VetoableDockFrontendListeners for questioning about some operations.

Returns:

all the listeners that could have a veto