bibliothek.gui.dock

Class ToolbarContainerDockStation

java.lang.Object

bibliothek.gui.dock.dockable.AbstractDockable

bibliothek.gui.dock.station.AbstractDockableStation

bibliothek.gui.dock.ToolbarContainerDockStation

All Implemented Interfaces:

DockComponentRoot, DockElement, DockElementRepresentative, OrientedDockStation, OrientingDockStation, PlaceholderListItem<Dockable>, Dockable, DockStation

public class ToolbarContainerDockStation
extends AbstractDockableStation
implements OrientingDockStation, OrientedDockStation

A Dockable and a DockStation which stands for a group of ToolbarGroupDockStation. As dockable it can be put in every DockStation. As DockStation it accepts only ToolbarElementInterfaces. When ToolbarElement are added, all the ComponentDockable extracted from the element are merged together and wrapped in a ToolbarGroupDockStation before to be added.

Author:

Herve Guillaume

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ToolbarContainerDockStation.OverpaintablePanelBase This panel is used as base of the station.

Field Summary

Fields

Modifier and Type	Field and Description
static Orientation	DEFAULT_ORIENTATION
static String	DISPLAYER_ID This id is forwarded to Extensions which load additional DisplayerFactorys
protected ToolbarContainerDockStation.OverpaintablePanelBase	mainPanel The graphical representation of this station: the pane which contains toolbars
static String	TITLE_ID the id of the DockTitleFactory used with this station

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

listeners

Constructor Summary

Constructors

Constructor and Description
ToolbarContainerDockStation(Orientation orientation) Constructs a new ContainerLineStation
ToolbarContainerDockStation(Orientation orientation, int maxNumberOfDockables) Creates a new station

Method Summary

Modifier and Type	Method and Description
boolean	accept(Dockable child)
boolean	accept(DockStation station)
protected boolean	add(Dockable dockable, int index) Add one dockable at the index position.
protected boolean	add(Dockable dockable, int index, Path placeholder)
void	addOrientingDockStationListener(OrientingDockStationListener listener) Adds the observer listener to this station.
void	aside(AsideRequest request)
protected void	callDockUiUpdateTheme()
boolean	canDrag(Dockable dockable)
boolean	canReplace(Dockable old, Dockable next)
protected ToolbarContainerConverter	createConverter() Creates a ToolbarContainerConverter which will be used for one call.
protected DockComponentRootHandler	createRootHandler()
protected void	discard(DockableDisplayer displayer) Replaces displayer with a new DockableDisplayer.
void	drag(Dockable dockable)
void	drop(Dockable dockable) Adds dockable to this station.
boolean	drop(Dockable dockable, DockableProperty property)
protected void	fireOrientingEvent() Fires an OrientingDockStationEvent.
Component	getComponent()
JPanel	getContainerPanel() Gets the panel which contains dockables
Dockable	getDockable(int index)
int	getDockableCount()
DockableProperty	getDockableProperty(Dockable child, Dockable target)
DockablePlaceholderList<StationChildHandle>	getDockables() Gets the dockables in the station
int	getDockablesMaxNumber() Gets the number of dockables that this station will accept.
String	getFactoryID()
Dockable	getFrontDockable()
DockStationDropLayer[]	getLayers()
Orientation	getOrientation() Gets the orientation of dockables in the station
Orientation	getOrientationOf(Dockable child) Tells what orientation child has.
DefaultStationPaintValue	getPaint() Gets a StationPaint which is used to paint some lines onto this station.
PlaceholderMapping	getPlaceholderMapping()
PlaceholderMap	getPlaceholders()
PlaceholderMap	getPlaceholders(Map<Dockable,Integer> children) Gets the layout of this station encoded as PlaceholderMap.
PlaceholderStrategy	getPlaceholderStrategy() Gets the PlaceholderStrategy that is currently in use.
int	getSideSnapSize() Gets the number of pixels outside the station where a drag and drop operation can still start
ToolbarStrategy	getToolbarStrategy() Gets the ToolbarStrategy that is currently used by this station.
void	move(Dockable dockable, DockableProperty property)
StationDragOperation	prepareDrag(Dockable dockable)
StationDropOperation	prepareDrop(StationDropItem item)
void	removeOrientingDockStationListener(OrientingDockStationListener listener) Removes the observer listener from this station.
void	replace(Dockable old, Dockable next)
void	replace(DockStation old, Dockable next)
void	setController(DockController controller)
void	setDockablesMaxNumber(int max) Sets the number of dockables that this station will accept (max = -1 indicates that there's no limit).
void	setDockParent(DockStation station)
void	setFrontDockable(Dockable dockable)
void	setOrientation(Orientation orientation) Sets the orientation of dockables in the station
void	setPlaceholders(PlaceholderMap placeholders)
void	setPlaceholders(PlaceholderMap placeholders, Map<Integer,Dockable> children) Sets the layout of this station using the encoded layout from placeholders
void	setPlaceholderStrategy(PlaceholderStrategy strategy) Sets the PlaceholderStrategy to use, null will set the default strategy.
void	setSideSnapSize(int sideSnapSize) Sets the number of pixels outside the station where a drag and drop operation can still start.
String	toString()

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

acceptable, acceptable, addDockStationListener, asDockStation, changed, createTitleIcon, delegate, fireDockablesRepositioned, fireDockablesRepositioned, getDirectActionOffers, getIndirectActionOffers, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, removeDockStationListener, requestChildDisplayer, requestChildDockTitle, updateTheme

Methods inherited from class bibliothek.gui.dock.dockable.AbstractDockable

accept, addDockableListener, addDockableStateListener, addDockHierarchyListener, addKeyListener, addMouseInputListener, asDockable, bind, configureDisplayerHints, fireTitleBound, fireTitleExchanged, fireTitleExchanged, fireTitleIconChanged, fireTitleTextChanged, fireTitleTooltipChanged, fireTitleUnbound, getComponentConfiguration, getConfigurableDisplayerHints, getController, getDockableStateListeners, getDockElementObserver, getDockParent, getElement, getGlobalActionOffers, getLocalActionOffers, getPopupLocation, getRootHandler, getTitleIcon, getTitleIconHandling, getTitleText, getTitleToolTip, isDockableShowing, isDockableVisible, isUsedAsTitle, listBoundTitles, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeKeyListener, removeMouseInputListener, requestDisplayer, requestDockTitle, resetTitleIcon, setActionOffers, setComponentConfiguration, setTitleIcon, setTitleIconHandling, setTitleText, setTitleToolTip, shouldFocus, shouldTransfersFocus, unbind

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.DockStation

addDockStationListener, changed, getController, getDirectActionOffers, getIndirectActionOffers, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, removeDockStationListener, requestChildDisplayer, requestChildDockTitle, updateTheme

Methods inherited from interface bibliothek.gui.dock.DockElement

asDockable, asDockStation

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

getComponentConfiguration, setComponentConfiguration

Field Detail

TITLE_ID

public static final String TITLE_ID

the id of the DockTitleFactory used with this station

See Also:

Constant Field Values

DISPLAYER_ID

public static final String DISPLAYER_ID

This id is forwarded to Extensions which load additional DisplayerFactorys

See Also:

Constant Field Values

DEFAULT_ORIENTATION

public static final Orientation DEFAULT_ORIENTATION

mainPanel

protected ToolbarContainerDockStation.OverpaintablePanelBase mainPanel

The graphical representation of this station: the pane which contains toolbars

Constructor Detail

ToolbarContainerDockStation

public ToolbarContainerDockStation(Orientation orientation)

Constructs a new ContainerLineStation

ToolbarContainerDockStation

public ToolbarContainerDockStation(Orientation orientation,
                                   int maxNumberOfDockables)

Creates a new station

Parameters:

orientation - the orientation of the content

maxNumberOfDockables - the maximum number of children or -1

Method Detail

createRootHandler

protected DockComponentRootHandler createRootHandler()

Specified by:

createRootHandler in class AbstractDockable

getDockableCount

public int getDockableCount()

Specified by:

getDockableCount in interface DockStation

getDockable

public Dockable getDockable(int index)

Specified by:

getDockable in interface DockStation

getFrontDockable

public Dockable getFrontDockable()

Specified by:

getFrontDockable in interface DockStation

setFrontDockable

public void setFrontDockable(Dockable dockable)

Specified by:

setFrontDockable in interface DockStation

getPlaceholders

public PlaceholderMap getPlaceholders()

Specified by:

getPlaceholders in interface DockStation

getPlaceholders

public PlaceholderMap getPlaceholders(Map<Dockable,Integer> children)

Gets the layout of this station encoded as PlaceholderMap.

Parameters:

children - identifiers for the children

Returns:

the encoded layout, not null

getPlaceholderMapping

public PlaceholderMapping getPlaceholderMapping()

Specified by:

getPlaceholderMapping in interface DockStation

setPlaceholders

public void setPlaceholders(PlaceholderMap placeholders)

Specified by:

setPlaceholders in interface DockStation

setPlaceholders

public void setPlaceholders(PlaceholderMap placeholders,
                            Map<Integer,Dockable> children)

Sets the layout of this station using the encoded layout from placeholders

Parameters:

placeholders - the placeholders to read

children - the children to add

createConverter

protected ToolbarContainerConverter createConverter()

Creates a ToolbarContainerConverter which will be used for one call.

Returns:

the new converter, not null

getPlaceholderStrategy

public PlaceholderStrategy getPlaceholderStrategy()

Gets the PlaceholderStrategy that is currently in use.

Returns:

the current strategy, may be null

setPlaceholderStrategy

public void setPlaceholderStrategy(PlaceholderStrategy strategy)

Sets the PlaceholderStrategy to use, null will set the default strategy.

Parameters:

strategy - the new strategy, can be null

getDockableProperty

public DockableProperty getDockableProperty(Dockable child,
                                            Dockable target)

Specified by:

getDockableProperty in interface DockStation

aside

public void aside(AsideRequest request)

Specified by:

aside in interface DockStation

prepareDrag

public StationDragOperation prepareDrag(Dockable dockable)

Specified by:

prepareDrag in interface DockStation

setSideSnapSize

public void setSideSnapSize(int sideSnapSize)

Sets the number of pixels outside the station where a drag and drop operation can still start.

Parameters:

sideSnapSize - the size in pixels

getSideSnapSize

public int getSideSnapSize()

Gets the number of pixels outside the station where a drag and drop operation can still start

Returns:

the size in pixels

getLayers

public DockStationDropLayer[] getLayers()

Specified by:

getLayers in interface DockStation

Overrides:

getLayers in class AbstractDockableStation

prepareDrop

public StationDropOperation prepareDrop(StationDropItem item)

Specified by:

prepareDrop in interface DockStation

addOrientingDockStationListener

public void addOrientingDockStationListener(OrientingDockStationListener listener)

Description copied from interface: OrientingDockStation

Adds the observer listener to this station. The observer receives an event if the orientation of a child of this station changed. The observer may or may not receive an event upon dropping a new Dockable onto this station.

Specified by:

addOrientingDockStationListener in interface OrientingDockStation

Parameters:

listener - the new observer, not null

removeOrientingDockStationListener

public void removeOrientingDockStationListener(OrientingDockStationListener listener)

Description copied from interface: OrientingDockStation

Removes the observer listener from this station.

Specified by:

removeOrientingDockStationListener in interface OrientingDockStation

Parameters:

listener - the listener to remove

getOrientationOf

public Orientation getOrientationOf(Dockable child)

Description copied from interface: OrientingDockStation

Tells what orientation child has.

Specified by:

getOrientationOf in interface OrientingDockStation

Parameters:

child - a child of this station

Returns:

the orientation, never null

setDockablesMaxNumber

public void setDockablesMaxNumber(int max)

Sets the number of dockables that this station will accept (max = -1 indicates that there's no limit).

Parameters:

max - the number of dockables accepted

getDockablesMaxNumber

public int getDockablesMaxNumber()

Gets the number of dockables that this station will accept.

Returns:

the number of dockables accepted (-1 if there is no maximum number)

fireOrientingEvent

protected void fireOrientingEvent()

Fires an OrientingDockStationEvent.

Parameters:

dockables - the items whose orientation changed

drop

public boolean drop(Dockable dockable,
                    DockableProperty property)

Specified by:

drop in interface DockStation

drop

public void drop(Dockable dockable)

Adds dockable to this station. The dockable must be a ToolbarElementInterface : if not, do nothing. The dockable is added at the last position.

Specified by:

drop in interface DockStation

Parameters:

dockable - a new child

move

public void move(Dockable dockable,
                 DockableProperty property)

Specified by:

move in interface DockStation

canDrag

public boolean canDrag(Dockable dockable)

Specified by:

canDrag in interface DockStation

drag

public void drag(Dockable dockable)

Specified by:

drag in interface DockStation

canReplace

public boolean canReplace(Dockable old,
                          Dockable next)

Specified by:

canReplace in interface DockStation

replace

public void replace(Dockable old,
                    Dockable next)

Specified by:

replace in interface DockStation

replace

public void replace(DockStation old,
                    Dockable next)

Specified by:

replace in interface DockStation

getFactoryID

public String getFactoryID()

Specified by:

getFactoryID in interface DockElement

getComponent

public Component getComponent()

Specified by:

getComponent in interface DockElementRepresentative

Specified by:

getComponent in interface Dockable

callDockUiUpdateTheme

protected void callDockUiUpdateTheme()
                              throws IOException

Specified by:

callDockUiUpdateTheme in class AbstractDockableStation

Throws:

IOException

getContainerPanel

public JPanel getContainerPanel()

Gets the panel which contains dockables

Returns:

the panel which contains dockables

getToolbarStrategy

public ToolbarStrategy getToolbarStrategy()

Gets the ToolbarStrategy that is currently used by this station.

Returns:

the strategy, never null

accept

public boolean accept(Dockable child)

Specified by:

accept in interface DockStation

Overrides:

accept in class AbstractDockableStation

accept

public boolean accept(DockStation station)

Specified by:

accept in interface Dockable

Overrides:

accept in class AbstractDockable

toString

public String toString()

Overrides:

toString in class Object

getDockables

public DockablePlaceholderList<StationChildHandle> getDockables()

Gets the dockables in the station

Returns:

the dockables associated with the station

getOrientation

public Orientation getOrientation()

Gets the orientation of dockables in the station

Specified by:

getOrientation in interface OrientedDockStation

Returns:

the orientation

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation of dockables in the station

Specified by:

setOrientation in interface OrientedDockStation

Parameters:

orientation - the orientation

add

protected boolean add(Dockable dockable,
                      int index)

Add one dockable at the index position. The dockable can be a ToolbarItemDockable, ToolbarDockStation or a ToolbarGroupDockStation (see method accept()). All the ComponentDockable extracted from the element are merged together and wrapped in a ToolbarDockStation before to be added at index position

Parameters:

dockable - Dockable to add

index - Index where add dockable

Returns:

true if dropping was successful

add

protected boolean add(Dockable dockable,
                      int index,
                      Path placeholder)

discard

protected void discard(DockableDisplayer displayer)

Replaces displayer with a new DockableDisplayer.

Parameters:

displayer - the displayer to replace, must actually be shown on this station

getPaint

public DefaultStationPaintValue getPaint()

Gets a StationPaint which is used to paint some lines onto this station. Use a delegate to exchange the paint.

Returns:

the paint

setDockParent

public void setDockParent(DockStation station)

Specified by:

setDockParent in interface Dockable

Overrides:

setDockParent in class AbstractDockable

setController

public void setController(DockController controller)

Specified by:

setController in interface Dockable

Specified by:

setController in interface DockStation

Overrides:

setController in class AbstractDockable