bibliothek.gui.dock.common.intern.station
Class CScreenDockStation

java.lang.Object
  bibliothek.gui.dock.station.AbstractDockStation
      bibliothek.gui.dock.ScreenDockStation
          bibliothek.gui.dock.common.intern.station.CScreenDockStation

All Implemented Interfaces:

CommonElement, CommonDockStation<ScreenDockStation,CScreenDockStation>, DockComponentRoot, DockElement, DockStation

public class CScreenDockStation
extends ScreenDockStation
implements CommonDockStation<ScreenDockStation,CScreenDockStation>

A ScreenDockStation that also implements CommonDockStation.

Author:

Benjamin Sigg

Field Summary

Fields inherited from class bibliothek.gui.dock.ScreenDockStation

ATTRACTOR_STRATEGY, ATTRACTOR_STRATEGY_EXTENSION, BOUNDARY_RESTRICTION, DISPLAYER_ID, DROP_SIZE_STRATEGY, EXPAND_ON_DOUBLE_CLICK, EXTENSION_PARAM, FULL_SCREEN_STRATEGY, MAGNET_STRATEGY, PREVENT_FOCUS_STEALING_DELAY, STATION_EXTENSION, TITLE_ID, WINDOW_CLOSING_STRATEGY, WINDOW_CONFIGURATION, WINDOW_FACTORY

Fields inherited from class bibliothek.gui.dock.station.AbstractDockStation

listeners

Constructor Summary

CScreenDockStation(WindowProvider owner, CommonStationDelegate<CScreenDockStation> delegate)
Creates a new station.

Method Summary

CommonDockable	asDockable() Returns this if this is an instance of Dockable.
CScreenDockStation	asDockStation() Returns this if this is an instance of DockStation.
protected ListeningDockAction	createFullscreenAction() Creates an action which is added to all children of this station.
String	getConverterID() Gets the unique identifier of the DockFactory that should be used by the CommonDockStationFactory to actually write or read the layout.
ScreenDockStation	getDockStation() Gets this as S.
String	getFactoryID() Gets the unique name of the DockFactory which can read and write elements of this type.
CStation<CScreenDockStation>	getStation() Gets the model of this station.

Methods inherited from class bibliothek.gui.dock.ScreenDockStation

addDockable, addDockable, addDockable, addFullscreenFilter, addScreenDockStationListener, aside, callDockUiUpdateTheme, canDrag, canReplace, checkWindowBoundaries, clearExpandOnDoubleClick, combine, combine, createRootHandler, createWindow, deregister, drag, drop, drop, drop, drop, drop, getBoundaryRestriction, getCombiner, getConfiguration, getDirectActionOffers, getDisplayerFactory, getDisplayers, getDockable, getDockableCount, getDockableProperty, getDropOverRatio, getFrontDockable, getFullscreenChildren, getFullscreenStrategy, getIndirectActionOffers, getLayers, getLocation, getMagnetController, getOwner, getPaint, getPlaceholderMapping, getPlaceholders, getPlaceholders, getPlaceholderStrategy, getProvider, getStationBounds, getTitleVersion, getWindow, getWindow, getWindowConfiguration, getWindowConfigurationProperty, getWindowFactory, getWindowFactoryProperty, indexOf, isChildShowing, isExpandOnDoubleClick, isFullscreen, isShowing, isStationShowing, isStationVisible, isVisible, move, prepare, prepareDrag, prepareDrop, register, removeDockable, removeDockable, removeFullscreenFilter, removeScreenDockStationListener, replace, replace, replace, screenDockStationListeners, searchCombineDockable, setBoundaryRestriction, setController, setDropOverRatio, setExpandOnDoubleClick, setFrontDockable, setFullscreen, setFullscreenAction, setFullscreenStrategy, setPlaceholders, setPlaceholders, setPlaceholderStrategy, setShowing, setWindowConfiguration, setWindowFactory, updateWindows, updateWindows

Methods inherited from class bibliothek.gui.dock.station.AbstractDockStation

accept, addDockStationListener, canCompare, changed, compare, delegate, getComponentConfiguration, getController, getRootHandler, getTheme, removeDockStationListener, requestChildDisplayer, requestChildDockTitle, setComponentConfiguration, updateTheme

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

accept, addDockStationListener, aside, canDrag, canReplace, changed, drag, drop, drop, getController, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getFrontDockable, getIndirectActionOffers, getLayers, getPlaceholderMapping, getPlaceholders, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, move, prepareDrag, prepareDrop, removeDockStationListener, replace, replace, requestChildDisplayer, requestChildDockTitle, setController, setFrontDockable, setPlaceholders, updateTheme

Methods inherited from interface bibliothek.gui.dock.component.DockComponentRoot

getComponentConfiguration, setComponentConfiguration

Constructor Detail

CScreenDockStation

public CScreenDockStation(WindowProvider owner,
                          CommonStationDelegate<CScreenDockStation> delegate)

Creates a new station.

Parameters:

owner - the window that is the owner of the windows of this station

delegate - additional methods required for this station

Method Detail

getFactoryID

public String getFactoryID()

Description copied from interface: DockElement

Gets the unique name of the DockFactory which can read and write elements of this type.

Specified by:

getFactoryID in interface CommonDockStation<ScreenDockStation,CScreenDockStation>

Specified by:

getFactoryID in interface DockElement

Overrides:

getFactoryID in class ScreenDockStation

Returns:

the id of the factory

See Also:

CommonDockStation.getConverterID()

getConverterID

public String getConverterID()

Description copied from interface: CommonDockStation

Gets the unique identifier of the DockFactory that should be used by the CommonDockStationFactory to actually write or read the layout. Usually the result of this method is the same result as DockElement.getFactoryID() (note: the factory id from the super class).

Specified by:

getConverterID in interface CommonDockStation<ScreenDockStation,CScreenDockStation>

Returns:

the unique identifier of a DockFactory. Can be null if CommonDockStation.getFactoryID() does not return CommonDockStationFactory.FACTORY_ID

createFullscreenAction

protected ListeningDockAction createFullscreenAction()

Description copied from class: ScreenDockStation

Creates an action which is added to all children of this station. The action allows the user to expand a child to fullscreen. The action is also added to subchildren, but the effect does only affect direct children of this station.

Overrides:

createFullscreenAction in class ScreenDockStation

Returns:

the action or null if this feature should be disabled, or the action is set later

getDockStation

public ScreenDockStation getDockStation()

Description copied from interface: CommonDockStation

Gets this as S.

Specified by:

getDockStation in interface CommonDockStation<ScreenDockStation,CScreenDockStation>

Returns:

this

asDockStation

public CScreenDockStation asDockStation()

Description copied from interface: DockElement

Returns this if this is an instance of DockStation. Otherwise null is returned.

Specified by:

asDockStation in interface CommonElement

Specified by:

asDockStation in interface CommonDockStation<ScreenDockStation,CScreenDockStation>

Specified by:

asDockStation in interface DockElement

Overrides:

asDockStation in class ScreenDockStation

Returns:

this or null. Must not return null if DockElement.asDockable() already returns null

asDockable

public CommonDockable asDockable()

Description copied from interface: DockElement

Returns this if this is an instance of Dockable. Otherwise null is returned.

Specified by:

asDockable in interface CommonElement

Specified by:

asDockable in interface DockElement

Overrides:

asDockable in class ScreenDockStation

Returns:

this or null. Must not return null if DockElement.asDockable() already returns null.

getStation

public CStation<CScreenDockStation> getStation()

Description copied from interface: CommonDockStation

Gets the model of this station.

Specified by:

getStation in interface CommonDockStation<ScreenDockStation,CScreenDockStation>

Returns:

the model, may not be null