public abstract class AbstractDockStation extends Object implements DockStation
DockStation. This station
has the ability to send events to registered
DockStationListeners.| Modifier and Type | Field and Description |
|---|---|
protected DockStationListenerManager |
listeners
The list of
DockStationListeners which
can be used to send events to all listeners. |
| Constructor and Description |
|---|
AbstractDockStation() |
| 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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaside, canDrag, canReplace, drag, drop, drop, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getFrontDockable, getIndirectActionOffers, getLayers, getPlaceholderMapping, getPlaceholders, isChildShowing, isStationShowing, isStationVisible, move, prepareDrag, prepareDrop, replace, replace, setFrontDockable, setPlaceholdersasDockable, asDockStation, getFactoryIDprotected DockStationListenerManager listeners
DockStationListeners which
can be used to send events to all listeners.protected DockComponentRootHandler getRootHandler()
DockComponentRootHandler which is responsible for keeping track of all the
Components of this station.nullprotected abstract DockComponentRootHandler createRootHandler()
DockComponentRootHandler which will be responsible for keeping track of
all the Components of this station.public void setController(DockController controller)
DockStationDockTitle, 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.null means that this station is currently
not shown.setController in interface DockStationcontroller - the owner of this station, can be nullpublic DockController getController()
DockStationgetController in interface DockElementgetController in interface DockStationnull if no controller is setDockStation.setController(DockController)public DockComponentConfiguration getComponentConfiguration()
DockComponentRootgetComponentConfiguration in interface DockComponentRootnullpublic void setComponentConfiguration(DockComponentConfiguration configuration)
DockComponentRootComponents (and maybe their children) of this DockComponentRoot.setComponentConfiguration in interface DockComponentRootconfiguration - the new configuration or null.public DockTheme getTheme()
DockStationnull,
but that means that the station is not fully initialized, and might not
work correct.getTheme in interface DockStationnull.public void updateTheme()
DockStationDockTheme 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.DockUI.updateTheme(DockStation, DockFactory)
to implement this method.updateTheme in interface DockStationprotected abstract void callDockUiUpdateTheme()
throws IOException
DockUI.DockUI.updateTheme(DockStation, DockFactory)
with this as the first argument, and an appropriate factory
as the second argument.IOException - if the DockUI throws an exceptionpublic void addDockStationListener(DockStationListener listener)
DockStationaddDockStationListener in interface DockStationlistener - the listener to addpublic void removeDockStationListener(DockStationListener listener)
DockStationremoveDockStationListener in interface DockStationlistener - the listener to removepublic boolean isVisible(Dockable dockable)
DockStationdockable 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.isVisible in interface DockStationdockable - the child whose visibility-state is questioneddockable is visible or notDockStation.isStationVisible()public boolean accept(Dockable child)
DockStationchild 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.accept in interface DockStationchild - a Dockable which may become a childtrue if child is acceptedpublic boolean canCompare(DockStation station)
public int compare(DockStation station)
public void changed(Dockable dockable, DockTitle title, boolean active)
DockStationDockController 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.changed in interface DockStationdockable - the child whose title is changedtitle - the changed title, may not be boundactive - the new state of the titlepublic void requestChildDockTitle(DockTitleRequest request)
DockStationDockTitle for a child of this station. This method
must call DockTitleRequest.answer(DockTitle) to set the result.DockStations won't have the need to implement this method,
leaving it empty will advice the framework to use another source for
new DockTitles.requestChildDockTitle in interface DockStationrequest - the request to answer, not nullpublic void requestChildDisplayer(DisplayerRequest request)
DockStationDockableDisplayer for a child of this station. This method
must call DisplayerRequest.answer(DockableDisplayer) to set the result.requestChildDisplayer in interface DockStationrequest - the request to answer, not nullprotected DockStationDelegate delegate()
DockStation, and which perform
various tasks that are handled the same way in many implementations of DockStation.Copyright © 2017 Docking Frames. All rights reserved.