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

java.lang.Object
  extended by bibliothek.gui.dock.dockable.AbstractDockable
      extended by bibliothek.gui.dock.station.AbstractDockableStation
          extended by bibliothek.gui.dock.FlapDockStation
              extended by bibliothek.gui.dock.common.intern.station.CFlapDockStation
All Implemented Interfaces:
CommonElement, CommonDockStation<FlapDockStation,CFlapDockStation>, DockElement, DockElementRepresentative, PlaceholderListItem<Dockable>, Dockable, DockStation

public class CFlapDockStation
extends FlapDockStation
implements CommonDockStation<FlapDockStation,CFlapDockStation>

An implementation of FlapDockStation that also satisfies the CommonDockStation interface.

Author:
Benjamin Sigg

Nested Class Summary
 
Nested classes/interfaces inherited from class bibliothek.gui.dock.FlapDockStation
FlapDockStation.Direction
 
Field Summary
 
Fields inherited from class bibliothek.gui.dock.FlapDockStation
BUTTON_CONTENT, BUTTON_CONTENT_FILTER, BUTTON_TITLE_ID, LAYOUT_MANAGER, MINIMUM_SIZE, WINDOW_FACTORY, WINDOW_TITLE_ID
 
Fields inherited from class bibliothek.gui.dock.station.AbstractDockableStation
listeners
 
Constructor Summary
CFlapDockStation(java.awt.Component expansion, CommonStationDelegate<FlapDockStation> delegate)
          Creates a new station.
 
Method Summary
 CommonDockable asDockable()
          Returns this if this is an instance of Dockable.
 CFlapDockStation asDockStation()
          Returns this if this is an instance of DockStation.
 CDockable getDockable()
           
 FlapDockStation getDockStation()
          Gets this as S.
 java.awt.Rectangle getExpansionBounds()
          Gets the rectangle to which a flap-window will be attached.
 DockActionSource[] getSources()
           
 CStation<FlapDockStation> getStation()
          Gets the model of this station.
 void requestDockTitle(DockTitleRequest request)
          The default behavior of this method is todo nothing.
 
Methods inherited from class bibliothek.gui.dock.FlapDockStation
add, add, addFlapDockStationListener, callDockUiUpdateTheme, canDrag, canReplace, changed, combine, combine, createButtonPane, createFlapWindow, createHoldAction, drag, draw, drop, drop, drop, drop, fireHoldChanged, forget, getButton, getButtonVersion, getCombiner, getComponent, getDefaultWindowSize, getDirectActionOffers, getDirection, getDisplayerFactory, getDisplayers, getDockable, getDockableCount, getDockableProperty, getFactoryID, getFlapLayoutManager, getFrontDockable, getMinimumSize, getPaint, getPlaceholders, getPlaceholders, getPlaceholderStrategy, getStationBounds, getTitleVersion, getWindowBorder, getWindowMinSize, getWindowSize, indexOf, init, isAutoDirection, isFlapWindow, isHold, isInOverrideZone, isSmallButtons, isVisible, move, move, orientation, prepareDrop, prepareMove, recreateTitles, remove, remove, removeFlapDockStationListener, replace, replace, selfSetDirection, setAutoDirection, setController, setDefaultWindowSize, setDirection, setDockParent, setFlapLayoutManager, setFrontDockable, setHold, setMinimumSize, setPlaceholders, setPlaceholders, setPlaceholderStrategy, setSmallButtons, setWindowBorder, setWindowMinSize, setWindowSize, updateHold, updateWindowBounds, updateWindowSize
 
Methods inherited from class bibliothek.gui.dock.station.AbstractDockableStation
accept, acceptable, addDockStationListener, canCompare, compare, createTitleIcon, fireDockablesRepositioned, fireDockablesRepositioned, getIndirectActionOffers, getTheme, isStationVisible, removeDockStationListener, requestChildDockTitle, updateTheme
 
Methods inherited from class bibliothek.gui.dock.dockable.AbstractDockable
accept, accept, addDockableListener, addDockableStateListener, addDockHierarchyListener, addKeyListener, addMouseInputListener, bind, configureDisplayerHints, fireTitleBound, fireTitleExchanged, fireTitleExchanged, fireTitleIconChanged, fireTitleTextChanged, fireTitleTooltipChanged, fireTitleUnbound, getConfigurableDisplayerHints, getController, getDockableStateListeners, getDockElementObserver, getDockParent, getElement, getGlobalActionOffers, getLocalActionOffers, getPopupLocation, getTitleIcon, getTitleText, getTitleToolTip, isDockableVisible, isUsedAsTitle, listBoundTitles, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeKeyListener, removeMouseInputListener, resetTitleIcon, setActionOffers, setTitleIcon, setTitleText, setTitleToolTip, shouldFocus, shouldTransfersFocus, unbind
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.DockElement
getFactoryID
 
Methods inherited from interface bibliothek.gui.DockStation
accept, addDockStationListener, canCompare, canDrag, canReplace, changed, compare, drag, draw, drop, drop, drop, forget, getController, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getFrontDockable, getIndirectActionOffers, getPlaceholders, getStationBounds, getTheme, isInOverrideZone, isStationVisible, isVisible, move, move, prepareDrop, prepareMove, removeDockStationListener, replace, replace, requestChildDockTitle, setController, setFrontDockable, setPlaceholders, updateTheme
 
Methods inherited from interface bibliothek.gui.dock.DockElement
getFactoryID
 

Constructor Detail

CFlapDockStation

public CFlapDockStation(java.awt.Component expansion,
                        CommonStationDelegate<FlapDockStation> delegate)
Creates a new station.

Parameters:
expansion - the Component which should define the size and location of this station, can be null
delegate - offers additional methods required by this station
Method Detail

getDockable

public CDockable getDockable()

getSources

public DockActionSource[] getSources()

getStation

public CStation<FlapDockStation> getStation()
Description copied from interface: CommonDockStation
Gets the model of this station.

Specified by:
getStation in interface CommonDockStation<FlapDockStation,CFlapDockStation>
Returns:
the model, may not be null

getDockStation

public FlapDockStation getDockStation()
Description copied from interface: CommonDockStation
Gets this as S.

Specified by:
getDockStation in interface CommonDockStation<FlapDockStation,CFlapDockStation>
Returns:
this

asDockStation

public CFlapDockStation 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<FlapDockStation,CFlapDockStation>
Specified by:
asDockStation in interface DockElement
Overrides:
asDockStation in class AbstractDockableStation
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
Specified by:
asDockable in interface PlaceholderListItem<Dockable>
Overrides:
asDockable in class AbstractDockable
Returns:
this or null. Must not return null if DockElement.asDockable() already returns null.

getExpansionBounds

public java.awt.Rectangle getExpansionBounds()
Description copied from class: FlapDockStation
Gets the rectangle to which a flap-window will be attached. The default is a rectangle that lies exactly over this component. The coordinates of the result are relative to the component of this station.

Overrides:
getExpansionBounds in class FlapDockStation
Returns:
the free area near a window

requestDockTitle

public void requestDockTitle(DockTitleRequest request)
Description copied from class: AbstractDockable
The default behavior of this method is todo nothing.

Specified by:
requestDockTitle in interface Dockable
Overrides:
requestDockTitle in class AbstractDockableStation
Parameters:
request - which title is required. If this Dockable does not have a special rule for the given request it just ignores the call