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

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLayeredPane
                  bibliothek.gui.dock.station.OverpaintablePanel
                      bibliothek.gui.dock.security.SecureContainer
                          bibliothek.gui.dock.SplitDockStation
                              bibliothek.gui.dock.common.intern.station.CSplitDockStation

All Implemented Interfaces:

CommonDockable, CommonElement, CommonDockStation<SplitDockStation,CSplitDockStation>, DockComponentRoot, DockElement, DockElementRepresentative, PlaceholderListItem<Dockable>, Dockable, DockStation, ImageObserver, MenuContainer, Serializable, Accessible

@FrameworkOnly
public class CSplitDockStation
extends SplitDockStation
implements CommonDockStation<SplitDockStation,CSplitDockStation>, CommonDockable

An implementation of SplitDockStation that also satisfies the CommonDockStation interface.

Author:

Benjamin Sigg

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class bibliothek.gui.dock.SplitDockStation

SplitDockStation.Access, SplitDockStation.Orientation

Nested classes/interfaces inherited from class javax.swing.JLayeredPane

JLayeredPane.AccessibleJLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class bibliothek.gui.dock.SplitDockStation

DISPLAYER_ID, DIVIDER_STRATEGY, dockStationListeners, LAYOUT_MANAGER, MAXIMIZE_ACCELERATOR, TITLE_ID

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

CSplitDockStation(CommonStationDelegate<CSplitDockStation> delegate)

Method Summary

CommonDockable	asDockable() Returns this if this is an instance of Dockable.
CSplitDockStation	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.
CDockable	getDockable() Gets the model of this dockable.
SplitDockStation	getDockStation() Gets this as S.
String	getFactoryID() Gets the unique name of the DockFactory which can read and write elements of this type.
DockActionSource[]	getSources() Gets a set of DockActionSources which are to be displayed on this CommonDockable.
CStation<CSplitDockStation>	getStation() Gets the model of this station.
void	requestDockTitle(DockTitleRequest request) Invoked to get a graphical representation of a title for this Dockable.
void	setFrontDockable(Dockable dockable) Sets the most important child.
void	setNextFullScreen() Switches the child which is in fullscreen-mode.

Methods inherited from class bibliothek.gui.dock.SplitDockStation

accept, accept, accept, addDockable, addDockableListener, addDockableStateListener, addDockHierarchyListener, addDockStationListener, addMouseInputListener, addSplitDockStationListener, aside, bind, callDockUiUpdateTheme, canDrag, canReplace, changed, configureDisplayerHints, createPlaceholderConverter, createRootHandler, createTree, createTree, discard, drag, drop, drop, drop, drop, drop, drop, dropAside, dropGrid, dropOver, dropOver, dropTree, dropTree, fireFullScreenChanged, fireTitleExchanged, fireTitleExchanged, getAccess, getBorderSideSnapSize, getCombiner, getComponent, getComponentConfiguration, getConfigurableDisplayerHints, getController, getCurrentSplitLayoutManager, getDirectActionOffers, getDisplayerFactory, getDisplayers, getDividerSize, getDividerStrategy, getDockable, getDockableCount, getDockableLocationProperty, getDockablePathProperty, getDockablePathProperty, getDockablePlaceholderProperty, getDockableProperty, getDockParent, getDropInfo, getDropInfo, getElement, getFrontDockable, getFullScreen, getGlobalActionOffers, getIndirectActionOffers, getLayers, getLocalActionOffers, getLowestNode, getMinimumLeafSize, getMinimumSize, getNode, getNodeFactory, getPaint, getPlaceholderMapping, getPlaceholders, getPlaceholderStrategy, getPopupLocation, getPreferredSize, getRoot, getSideSnapSize, getSpanStrategy, getSplitLayoutManager, getTheme, getTitleIcon, getTitleText, getTitleToolTip, hasFullScreenAction, indexOfDockable, isAllowSideSnap, isChildShowing, isContinousDisplay, isDisabled, isDockableShowing, isDockableVisible, isExpandOnDoubleclick, isFullScreen, isResizingEnabled, isStationShowing, isStationVisible, isUsedAsTitle, isVisible, listBoundTitles, move, paintOverlay, prepareDrag, prepareDrop, removeAllDockables, removeDockable, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeDockStationListener, removeMouseInputListener, removePlaceholder, removePlaceholders, removeSplitDockStationListener, replace, replace, requestChildDisplayer, requestChildDockTitle, requestDisplayer, resetTitleIcon, root, setAllowSideSnap, setBorderSideSnapSize, setComponentConfiguration, setContinousDisplay, setController, setDisabled, setDividerSize, setDividerStrategy, setDockParent, setDropInfo, setExpandOnDoubleclick, setFullScreen, setFullScreenAction, setMinimumLeafSize, setNodeFactory, setPlaceholders, setPlaceholderStrategy, setPut, setResizingEnabled, setSideSnapSize, setSplitLayoutManager, setTitleIcon, setTitleText, setTitleToolTip, shouldFocus, shouldTransfersFocus, toString, unbind, unsetDropInfo, unsetPut, updateBounds, updateConfigurableDisplayerHints, updateTheme, updateVisibility, visit

Methods inherited from class bibliothek.gui.dock.security.SecureContainer

createGlassPane, install, isUseGlassPane, setUseGlassPane, uninstall

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

doLayout, getBasePane, getContentPane, getMaximumSize, isSolid, setBasePane, setContentPane, setSolid

Methods inherited from class javax.swing.JLayeredPane

addImpl, getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, paramString, putLayer, remove, removeAll, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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, setPlaceholders, updateTheme

Methods inherited from interface bibliothek.gui.Dockable

accept, accept, addDockableListener, addDockableStateListener, addDockHierarchyListener, addMouseInputListener, bind, configureDisplayerHints, getComponent, getController, getDockParent, getGlobalActionOffers, getLocalActionOffers, getTitleIcon, getTitleText, getTitleToolTip, isDockableShowing, isDockableVisible, listBoundTitles, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeMouseInputListener, requestDisplayer, setController, setDockParent, unbind

Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative

getElement, getPopupLocation, isUsedAsTitle, shouldFocus, shouldTransfersFocus

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

getComponentConfiguration, setComponentConfiguration

Constructor Detail

CSplitDockStation

public CSplitDockStation(CommonStationDelegate<CSplitDockStation> delegate)

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 CommonDockable

Specified by:

getFactoryID in interface CommonDockStation<SplitDockStation,CSplitDockStation>

Specified by:

getFactoryID in interface DockElement

Overrides:

getFactoryID in class SplitDockStation

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<SplitDockStation,CSplitDockStation>

Returns:

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

getDockable

public CDockable getDockable()

Description copied from interface: CommonDockable

Gets the model of this dockable.

Specified by:

getDockable in interface CommonDockable

Returns:

the model

getStation

public CStation<CSplitDockStation> getStation()

Description copied from interface: CommonDockStation

Gets the model of this station.

Specified by:

getStation in interface CommonDockable

Specified by:

getStation in interface CommonDockStation<SplitDockStation,CSplitDockStation>

Returns:

the model, may not be null

getDockStation

public SplitDockStation getDockStation()

Description copied from interface: CommonDockStation

Gets this as S.

Specified by:

getDockStation in interface CommonDockStation<SplitDockStation,CSplitDockStation>

Returns:

this

asDockStation

public CSplitDockStation 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<SplitDockStation,CSplitDockStation>

Specified by:

asDockStation in interface DockElement

Overrides:

asDockStation in class SplitDockStation

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 SplitDockStation

Returns:

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

createFullScreenAction

protected ListeningDockAction createFullScreenAction()

Description copied from class: SplitDockStation

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 SplitDockStation

Returns:

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

setNextFullScreen

public void setNextFullScreen()

Description copied from class: SplitDockStation

Switches the child which is in fullscreen-mode. If there is no child, nothing will happen. If there is only one child, it will be set to fullscreen (if it is not already fullscreen).

Overrides:

setNextFullScreen in class SplitDockStation

setFrontDockable

public void setFrontDockable(Dockable dockable)

Description copied from interface: DockStation

Sets the most important child. The station should ensure that this child is visible (assuming the station itself is visible). Read the comment on DockStation.getFrontDockable() how stations can change this property.

Specified by:

setFrontDockable in interface DockStation

Overrides:

setFrontDockable in class SplitDockStation

Parameters:

dockable - the new favorite child, can be null

See Also:

DockStation.getFrontDockable()

getSources

public DockActionSource[] getSources()

Description copied from interface: CommonDockable

Gets a set of DockActionSources which are to be displayed on this CommonDockable. Note that every call to this method should return the same array of sources. Callers should not modify the result.

Specified by:

getSources in interface CommonDockable

Returns:

the action sources, can be an empty array

requestDockTitle

public void requestDockTitle(DockTitleRequest request)

Description copied from interface: Dockable

Invoked to get a graphical representation of a title for this Dockable. This method is called either when a title first is required, or when this Dockable invoked the DockableListener.titleExchanged(Dockable, DockTitle) method of its current observers.
This Dockable might decide to answer the request by calling DockTitleRequest.answer(DockTitle), any title, including null are valid answers. If this Dockable does not answer the request the associated DockTitleFactory (as described by DockTitleVersion.getFactory()) is asked to answer the request.
The requests target must be this Dockable.
The normal behavior of this method is to do nothing.

Specified by:

requestDockTitle in interface Dockable

Overrides:

requestDockTitle in class SplitDockStation

Parameters:

request - which title is required. If this Dockable does not have a special rule for the given request it just ignores the call