|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectbibliothek.gui.dock.dockable.AbstractDockable
bibliothek.gui.dock.station.AbstractDockableStation
bibliothek.gui.dock.ToolbarContainerDockStation
public class ToolbarContainerDockStation
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.
| Nested Class Summary | |
|---|---|
protected class |
ToolbarContainerDockStation.OverpaintablePanelBase
This panel is used as base of the station. |
| Field Summary | |
|---|---|
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 | |
|---|---|
ToolbarContainerDockStation(Orientation orientation)
Constructs a new ContainerLineStation |
|
ToolbarContainerDockStation(Orientation orientation,
int maxNumberOfDockables)
Creates a new station |
|
| Method Summary | |
|---|---|
boolean |
accept(bibliothek.gui.Dockable child)
|
boolean |
accept(bibliothek.gui.DockStation station)
|
protected boolean |
add(bibliothek.gui.Dockable dockable,
int index)
Add one dockable at the index position. |
protected boolean |
add(bibliothek.gui.Dockable dockable,
int index,
bibliothek.util.Path placeholder)
|
void |
addOrientingDockStationListener(OrientingDockStationListener listener)
Adds the observer listener to this station. |
protected void |
callDockUiUpdateTheme()
|
boolean |
canDrag(bibliothek.gui.Dockable dockable)
|
boolean |
canReplace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
|
protected ToolbarContainerConverter |
createConverter()
Creates a ToolbarContainerConverter which will be used for one
call. |
protected void |
discard(bibliothek.gui.dock.station.DockableDisplayer displayer)
Replaces displayer with a new DockableDisplayer. |
void |
drag(bibliothek.gui.Dockable dockable)
|
void |
drop(bibliothek.gui.Dockable dockable)
Adds dockable to this station. |
boolean |
drop(bibliothek.gui.Dockable dockable,
bibliothek.gui.dock.layout.DockableProperty property)
|
protected void |
fireOrientingEvent()
Fires an OrientingDockStationEvent. |
Component |
getComponent()
|
JPanel |
getContainerPanel()
Gets the panel which contains dockables |
bibliothek.gui.Dockable |
getDockable(int index)
|
int |
getDockableCount()
|
bibliothek.gui.dock.layout.DockableProperty |
getDockableProperty(bibliothek.gui.Dockable child,
bibliothek.gui.Dockable target)
|
bibliothek.gui.dock.station.support.DockablePlaceholderList<bibliothek.gui.dock.station.StationChildHandle> |
getDockables()
Gets the dockables in the station |
int |
getDockablesMaxNumber()
Gets the number of dockables that this station will accept. |
String |
getFactoryID()
|
bibliothek.gui.Dockable |
getFrontDockable()
|
bibliothek.gui.dock.station.layer.DockStationDropLayer[] |
getLayers()
|
Orientation |
getOrientation()
Gets the orientation of dockables in the station |
Orientation |
getOrientationOf(bibliothek.gui.Dockable child)
Tells what orientation child has. |
bibliothek.gui.dock.themes.DefaultStationPaintValue |
getPaint()
Gets a StationPaint which is used to paint some lines onto this
station. |
bibliothek.gui.dock.station.support.PlaceholderMap |
getPlaceholders()
|
bibliothek.gui.dock.station.support.PlaceholderMap |
getPlaceholders(Map<bibliothek.gui.Dockable,Integer> children)
Gets the layout of this station encoded as PlaceholderMap. |
bibliothek.gui.dock.station.support.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(bibliothek.gui.Dockable dockable,
bibliothek.gui.dock.layout.DockableProperty property)
|
bibliothek.gui.dock.station.StationDragOperation |
prepareDrag(bibliothek.gui.Dockable dockable)
|
bibliothek.gui.dock.station.StationDropOperation |
prepareDrop(bibliothek.gui.dock.station.StationDropItem item)
|
void |
removeOrientingDockStationListener(OrientingDockStationListener listener)
Removes the observer listener from this station. |
void |
replace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
|
void |
replace(bibliothek.gui.DockStation old,
bibliothek.gui.Dockable next)
|
void |
setController(bibliothek.gui.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(bibliothek.gui.DockStation station)
|
void |
setFrontDockable(bibliothek.gui.Dockable dockable)
|
void |
setOrientation(Orientation orientation)
Sets the orientation of dockables in the station |
void |
setPlaceholders(bibliothek.gui.dock.station.support.PlaceholderMap placeholders)
|
void |
setPlaceholders(bibliothek.gui.dock.station.support.PlaceholderMap placeholders,
Map<Integer,bibliothek.gui.Dockable> children)
Sets the layout of this station using the encoded layout from placeholders |
void |
setPlaceholderStrategy(bibliothek.gui.dock.station.support.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, 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, getConfigurableDisplayerHints, getController, getDockableStateListeners, getDockElementObserver, getDockParent, getElement, getGlobalActionOffers, getLocalActionOffers, getPopupLocation, getTitleIcon, getTitleIconHandling, getTitleText, getTitleToolTip, isDockableShowing, isDockableVisible, isUsedAsTitle, listBoundTitles, removeDockableListener, removeDockableStateListener, removeDockHierarchyListener, removeKeyListener, removeMouseInputListener, requestDisplayer, requestDockTitle, resetTitleIcon, setActionOffers, 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 |
| Field Detail |
|---|
public static final String TITLE_ID
DockTitleFactory used with this station
public static final String DISPLAYER_ID
Extensions which load additional
DisplayerFactorys
public static final Orientation DEFAULT_ORIENTATION
protected ToolbarContainerDockStation.OverpaintablePanelBase mainPanel
| Constructor Detail |
|---|
public ToolbarContainerDockStation(Orientation orientation)
public ToolbarContainerDockStation(Orientation orientation,
int maxNumberOfDockables)
orientation - the orientation of the contentmaxNumberOfDockables - the maximum number of children or -1| Method Detail |
|---|
public int getDockableCount()
getDockableCount in interface bibliothek.gui.DockStationpublic bibliothek.gui.Dockable getDockable(int index)
getDockable in interface bibliothek.gui.DockStationpublic bibliothek.gui.Dockable getFrontDockable()
getFrontDockable in interface bibliothek.gui.DockStationpublic void setFrontDockable(bibliothek.gui.Dockable dockable)
setFrontDockable in interface bibliothek.gui.DockStationpublic bibliothek.gui.dock.station.support.PlaceholderMap getPlaceholders()
getPlaceholders in interface bibliothek.gui.DockStationpublic bibliothek.gui.dock.station.support.PlaceholderMap getPlaceholders(Map<bibliothek.gui.Dockable,Integer> children)
PlaceholderMap.
children - identifiers for the children
nullpublic void setPlaceholders(bibliothek.gui.dock.station.support.PlaceholderMap placeholders)
setPlaceholders in interface bibliothek.gui.DockStation
public void setPlaceholders(bibliothek.gui.dock.station.support.PlaceholderMap placeholders,
Map<Integer,bibliothek.gui.Dockable> children)
placeholders
placeholders - the placeholders to readchildren - the children to addprotected ToolbarContainerConverter createConverter()
ToolbarContainerConverter which will be used for one
call.
nullpublic bibliothek.gui.dock.station.support.PlaceholderStrategy getPlaceholderStrategy()
PlaceholderStrategy that is currently in use.
nullpublic void setPlaceholderStrategy(bibliothek.gui.dock.station.support.PlaceholderStrategy strategy)
PlaceholderStrategy to use, null will set
the default strategy.
strategy - the new strategy, can be null
public bibliothek.gui.dock.layout.DockableProperty getDockableProperty(bibliothek.gui.Dockable child,
bibliothek.gui.Dockable target)
getDockableProperty in interface bibliothek.gui.DockStationpublic bibliothek.gui.dock.station.StationDragOperation prepareDrag(bibliothek.gui.Dockable dockable)
prepareDrag in interface bibliothek.gui.DockStationpublic void setSideSnapSize(int sideSnapSize)
sideSnapSize - the size in pixelspublic int getSideSnapSize()
public bibliothek.gui.dock.station.layer.DockStationDropLayer[] getLayers()
getLayers in interface bibliothek.gui.DockStationgetLayers in class bibliothek.gui.dock.station.AbstractDockableStationpublic bibliothek.gui.dock.station.StationDropOperation prepareDrop(bibliothek.gui.dock.station.StationDropItem item)
prepareDrop in interface bibliothek.gui.DockStationpublic void addOrientingDockStationListener(OrientingDockStationListener listener)
OrientingDockStationlistener 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.
addOrientingDockStationListener in interface OrientingDockStationlistener - the new observer, not nullpublic void removeOrientingDockStationListener(OrientingDockStationListener listener)
OrientingDockStationlistener from this station.
removeOrientingDockStationListener in interface OrientingDockStationlistener - the listener to removepublic Orientation getOrientationOf(bibliothek.gui.Dockable child)
OrientingDockStationchild has.
getOrientationOf in interface OrientingDockStationchild - a child of this station
nullpublic void setDockablesMaxNumber(int max)
max - the number of dockables acceptedpublic int getDockablesMaxNumber()
protected void fireOrientingEvent()
OrientingDockStationEvent.
dockables - the items whose orientation changed
public boolean drop(bibliothek.gui.Dockable dockable,
bibliothek.gui.dock.layout.DockableProperty property)
drop in interface bibliothek.gui.DockStationpublic void drop(bibliothek.gui.Dockable dockable)
dockable to this station. The dockable must be a
ToolbarElementInterface : if not, do nothing. The dockable is
added at the last position.
drop in interface bibliothek.gui.DockStationdockable - a new child
public void move(bibliothek.gui.Dockable dockable,
bibliothek.gui.dock.layout.DockableProperty property)
move in interface bibliothek.gui.DockStationpublic boolean canDrag(bibliothek.gui.Dockable dockable)
canDrag in interface bibliothek.gui.DockStationpublic void drag(bibliothek.gui.Dockable dockable)
drag in interface bibliothek.gui.DockStation
public boolean canReplace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
canReplace in interface bibliothek.gui.DockStation
public void replace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
replace in interface bibliothek.gui.DockStation
public void replace(bibliothek.gui.DockStation old,
bibliothek.gui.Dockable next)
replace in interface bibliothek.gui.DockStationpublic String getFactoryID()
getFactoryID in interface bibliothek.gui.dock.DockElementpublic Component getComponent()
getComponent in interface bibliothek.gui.dock.DockElementRepresentativegetComponent in interface bibliothek.gui.Dockable
protected void callDockUiUpdateTheme()
throws IOException
callDockUiUpdateTheme in class bibliothek.gui.dock.station.AbstractDockableStationIOExceptionpublic JPanel getContainerPanel()
public ToolbarStrategy getToolbarStrategy()
ToolbarStrategy that is currently used by this station.
nullpublic boolean accept(bibliothek.gui.Dockable child)
accept in interface bibliothek.gui.DockStationaccept in class bibliothek.gui.dock.station.AbstractDockableStationpublic boolean accept(bibliothek.gui.DockStation station)
accept in interface bibliothek.gui.Dockableaccept in class bibliothek.gui.dock.dockable.AbstractDockablepublic String toString()
toString in class Objectpublic bibliothek.gui.dock.station.support.DockablePlaceholderList<bibliothek.gui.dock.station.StationChildHandle> getDockables()
public Orientation getOrientation()
getOrientation in interface OrientedDockStationpublic void setOrientation(Orientation orientation)
setOrientation in interface OrientedDockStationorientation - the orientation
protected boolean add(bibliothek.gui.Dockable dockable,
int index)
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
dockable - Dockable to addindex - Index where add dockable
true if dropping was successfull
protected boolean add(bibliothek.gui.Dockable dockable,
int index,
bibliothek.util.Path placeholder)
protected void discard(bibliothek.gui.dock.station.DockableDisplayer displayer)
displayer with a new DockableDisplayer.
displayer - the displayer to replace, must actually be shown on this
stationpublic bibliothek.gui.dock.themes.DefaultStationPaintValue getPaint()
StationPaint which is used to paint some lines onto this
station. Use a delegate to exchange the paint.
public void setDockParent(bibliothek.gui.DockStation station)
setDockParent in interface bibliothek.gui.DockablesetDockParent in class bibliothek.gui.dock.dockable.AbstractDockablepublic void setController(bibliothek.gui.DockController controller)
setController in interface bibliothek.gui.DockablesetController in interface bibliothek.gui.DockStationsetController in class bibliothek.gui.dock.dockable.AbstractDockable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||