bibliothek.gui.dock.station

Class AbstractDockStation

java.lang.Object

bibliothek.gui.dock.station.AbstractDockStation

All Implemented Interfaces:

DockComponentRoot, DockElement, DockStation

Direct Known Subclasses:

ScreenDockStation

public abstract class AbstractDockStation
extends Object
implements DockStation

An abstract implementation of DockStation. This station has the ability to send events to registered DockStationListeners.

Author:

Benjamin Sigg

Field Summary

Fields

Modifier and Type	Field and Description
protected DockStationListenerManager	listeners The list of DockStationListeners which can be used to send events to all listeners.

Constructor Summary

Constructors

Constructor and Description
AbstractDockStation()

Method Summary

Modifier and Type	Method and Description
boolean	accept(Dockable child) Tells whether this station accepts child as a new child, or refuses child.
void	addDockStationListener(DockStationListener listener) Adds a listener to this station.
protected abstract void	callDockUiUpdateTheme() Calls the method DockUI.DockUI.updateTheme(DockStation, DockFactory) with this as the first argument, and an appropriate factory as the second argument.
boolean	canCompare(DockStation station)
void	changed(Dockable dockable, DockTitle title, boolean active) Called by the DockController of this station to indicate that the active-state of title has been changed.
int	compare(DockStation station)
protected abstract DockComponentRootHandler	createRootHandler() Creates a new DockComponentRootHandler which will be responsible for keeping track of all the Components of this station.
protected DockStationDelegate	delegate() Creates a set of algorithms which may depend on this DockStation, and which perform various tasks that are handled the same way in many implementations of DockStation.
DockComponentConfiguration	getComponentConfiguration() Gets the currently applied configuration.
DockController	getController() Gets the controller of this station.
protected DockComponentRootHandler	getRootHandler() Gets the DockComponentRootHandler which is responsible for keeping track of all the Components of this station.
DockTheme	getTheme() Gets the current theme of this station.
boolean	isVisible(Dockable dockable) Tells whether the child dockable is visible or not.
void	removeDockStationListener(DockStationListener listener) Removes a listener from this station.
void	requestChildDisplayer(DisplayerRequest request) Provides a DockableDisplayer for a child of this station.
void	requestChildDockTitle(DockTitleRequest request) Provides a DockTitle for a child of this station.
void	setComponentConfiguration(DockComponentConfiguration configuration) Sets a configuration which is to be applied to all Components (and maybe their children) of this DockComponentRoot.
void	setController(DockController controller) Sets the controller of this station.
void	updateTheme() Updates the DockTheme of this station.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.DockStation

aside, canDrag, canReplace, drag, drop, drop, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getFrontDockable, getIndirectActionOffers, getLayers, getPlaceholderMapping, getPlaceholders, isChildShowing, isStationShowing, isStationVisible, move, prepareDrag, prepareDrop, replace, replace, setFrontDockable, setPlaceholders

Methods inherited from interface bibliothek.gui.dock.DockElement

asDockable, asDockStation, getFactoryID

Field Detail

listeners

protected DockStationListenerManager listeners

The list of DockStationListeners which can be used to send events to all listeners.

Constructor Detail

AbstractDockStation

public AbstractDockStation()

Method Detail

getRootHandler

protected DockComponentRootHandler getRootHandler()

Gets the DockComponentRootHandler which is responsible for keeping track of all the Components of this station.

Returns:

the root handler, not null

createRootHandler

protected abstract DockComponentRootHandler createRootHandler()

Creates a new DockComponentRootHandler which will be responsible for keeping track of all the Components of this station.

Returns:

the new handler

setController

public void setController(DockController controller)

Description copied from interface: DockStation

Sets the controller of this station. If the station wants to show any DockTitle, then the titles have to be replaced by new instances (assuming the controller is really new). The title has to get new DockTitleVersions through the DockTitleManager of controller.
An argument of null means that this station is currently not shown.

Specified by:

setController in interface DockStation

Parameters:

controller - the owner of this station, can be null

getController

public DockController getController()

Description copied from interface: DockStation

Gets the controller of this station.

Specified by:

getController in interface DockElement

Specified by:

getController in interface DockStation

Returns:

the controller or null if no controller is set

See Also:

DockStation.setController(DockController)

getComponentConfiguration

public DockComponentConfiguration getComponentConfiguration()

Description copied from interface: DockComponentRoot

Gets the currently applied configuration.

Specified by:

getComponentConfiguration in interface DockComponentRoot

Returns:

the current configuration, may be null

setComponentConfiguration

public void setComponentConfiguration(DockComponentConfiguration configuration)

Description copied from interface: DockComponentRoot

Sets a configuration which is to be applied to all Components (and maybe their children) of this DockComponentRoot.

Specified by:

setComponentConfiguration in interface DockComponentRoot

Parameters:

configuration - the new configuration or null.

getTheme

public DockTheme getTheme()

Description copied from interface: DockStation

Gets the current theme of this station. The theme can be null, but that means that the station is not fully initialized, and might not work correct.

Specified by:

getTheme in interface DockStation

Returns:

the theme of this station or null.

updateTheme

public void updateTheme()

Description copied from interface: DockStation

Updates the DockTheme of this station. The new theme has to be read from the controller of this station. If the controller is null, this method should return immediately.
You may use DockUI.updateTheme(DockStation, DockFactory) to implement this method.

Specified by:

updateTheme in interface DockStation

callDockUiUpdateTheme

protected abstract void callDockUiUpdateTheme()
                                       throws IOException

Calls the method DockUI.DockUI.updateTheme(DockStation, DockFactory) with this as the first argument, and an appropriate factory as the second argument.

Throws:

IOException - if the DockUI throws an exception

addDockStationListener

public void addDockStationListener(DockStationListener listener)

Description copied from interface: DockStation

Adds a listener to this station. The station has to invoke the methods of the listener such that its requirements are full filled.

Specified by:

addDockStationListener in interface DockStation

Parameters:

listener - the listener to add

removeDockStationListener

public void removeDockStationListener(DockStationListener listener)

Description copied from interface: DockStation

Removes a listener from this station.

Specified by:

removeDockStationListener in interface DockStation

Parameters:

listener - the listener to remove

isVisible

public boolean isVisible(Dockable dockable)

Description copied from interface: DockStation

Tells whether the child dockable is visible or not. Visible means that the component of dockable can be seen by the user. The result must be false if this station is not visible.

Specified by:

isVisible in interface DockStation

Parameters:

dockable - the child whose visibility-state is questioned

Returns:

whether dockable is visible or not

See Also:

DockStation.isStationVisible()

accept

public boolean accept(Dockable child)

Description copied from interface: DockStation

Tells whether this station accepts child as a new child, or refuses child. The user will not be able to drop a Dockable onto this station if this method returns false.

Specified by:

accept in interface DockStation

Parameters:

child - a Dockable which may become a child

Returns:

true if child is accepted

canCompare

public boolean canCompare(DockStation station)

compare

public int compare(DockStation station)

changed

public void changed(Dockable dockable,
                    DockTitle title,
                    boolean active)

Description copied from interface: DockStation

Called by the DockController of this station to indicate that the active-state of title has been changed. This station should call the method title.changed with an appropriate event. The station may add some additional information to this call.

Specified by:

changed in interface DockStation

Parameters:

dockable - the child whose title is changed

title - the changed title, may not be bound

active - the new state of the title

requestChildDockTitle

public void requestChildDockTitle(DockTitleRequest request)

Description copied from interface: DockStation

Provides a DockTitle for a child of this station. This method must call DockTitleRequest.answer(DockTitle) to set the result.
Most DockStations won't have the need to implement this method, leaving it empty will advice the framework to use another source for new DockTitles.

Specified by:

requestChildDockTitle in interface DockStation

Parameters:

request - the request to answer, not null

requestChildDisplayer

public void requestChildDisplayer(DisplayerRequest request)

Description copied from interface: DockStation

Provides a DockableDisplayer for a child of this station. This method must call DisplayerRequest.answer(DockableDisplayer) to set the result.
The usual implementation should be to do nothing.

Specified by:

requestChildDisplayer in interface DockStation

Parameters:

request - the request to answer, not null

delegate

protected DockStationDelegate delegate()

Creates a set of algorithms which may depend on this DockStation, and which perform various tasks that are handled the same way in many implementations of DockStation.

Returns:

the generic set of algorithms