|
||||||||||
| 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.AbstractToolbarDockStation
public abstract class AbstractToolbarDockStation
Base class of a DockStation behaving like a typical toolbar: the
children are ordered in a list, an optional title and border may be shown.
| Field Summary | |
|---|---|
protected bibliothek.gui.dock.themes.DefaultDisplayerFactoryValue |
displayerFactory
a factory used by displayers to create new
DockableDisplayers |
protected bibliothek.gui.dock.station.DisplayerCollection |
displayers
a helper class ensuring that all properties of the DockableDisplayers are set correctly |
protected Orientation |
orientation
Alignment of the content of this station |
protected bibliothek.gui.dock.themes.DefaultStationPaintValue |
paint
A paint to draw lines |
protected bibliothek.gui.dock.title.DockTitleVersion |
title
a factory creating new DockTitles |
| Fields inherited from class bibliothek.gui.dock.station.AbstractDockableStation |
|---|
listeners |
| Constructor Summary | |
|---|---|
AbstractToolbarDockStation()
Constructs a new ToolbarDockStation. |
|
| Method Summary | |
|---|---|
void |
addExpandableListener(ExpandableToolbarItemListener listener)
Adds the observer listener to this item. |
void |
addOrientingDockStationListener(OrientingDockStationListener listener)
Adds the observer listener to this station. |
boolean |
canDrag(bibliothek.gui.Dockable dockable)
|
boolean |
canReplace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
|
protected abstract bibliothek.gui.dock.themes.DefaultDisplayerFactoryValue |
createDisplayerFactory()
Creates a new DefaultDisplayerFactoryValue, a factory used to
create new DockableDisplayers. |
protected abstract void |
discard(bibliothek.gui.dock.station.DockableDisplayer displayer)
Replaces displayer with a new DockableDisplayer. |
protected ExpandableToolbarItemListener[] |
expandableListeners()
Gets all the ExpandableToolbarItemListeners that are currently
registered. |
protected void |
fireOrientingEvent()
Fires an OrientingDockStationEvent. |
ExpandedState |
getExpandedState()
Gets the current state of this item. |
bibliothek.gui.Dockable |
getFrontDockable()
|
Orientation |
getOrientation()
Gets the orientation of dockables in this 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. |
protected bibliothek.gui.Dockable |
getRemoval()
Gets the child of this station that is about to be removed. |
ToolbarStrategy |
getToolbarStrategy()
Gets the ToolbarStrategy that is currently used by this station. |
int |
indexOf(bibliothek.gui.Dockable dockable)
Gets the location of dockable in the component-panel. |
protected abstract void |
init()
Init the class and especially should ini the main panel. |
bibliothek.gui.dock.station.StationDragOperation |
prepareDrag(bibliothek.gui.Dockable dockable)
|
protected abstract bibliothek.gui.dock.title.DockTitleVersion |
registerTitle(bibliothek.gui.DockController controller)
Registers the default DockTitleFactory of this station at
controller and returns the associated
DockTitleVersion. |
protected abstract void |
remove(bibliothek.gui.Dockable dockable)
Removes dockable from this station.Note: clients may need to invoke DockController.freezeLayout()
and DockController.meltLayout() to ensure none else adds or
removes Dockables. |
void |
removeExpandableListener(ExpandableToolbarItemListener listener)
Removes the observer listener from this item. |
void |
removeOrientingDockStationListener(OrientingDockStationListener listener)
Removes the observer listener from this station. |
void |
replace(bibliothek.gui.DockStation old,
bibliothek.gui.Dockable next)
|
void |
setExpandedState(ExpandedState state)
Changes the state of this item to state. |
void |
setExpandedState(ExpandedState state,
boolean action)
Sets the ExpandedState of this station. |
void |
setFrontDockable(bibliothek.gui.Dockable dockable)
|
void |
shrink()
|
void |
stretch()
|
String |
toString()
|
| Methods inherited from class bibliothek.gui.dock.station.AbstractDockableStation |
|---|
accept, acceptable, acceptable, addDockStationListener, asDockStation, callDockUiUpdateTheme, changed, createTitleIcon, fireDockablesRepositioned, fireDockablesRepositioned, getDirectActionOffers, getIndirectActionOffers, getLayers, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, removeDockStationListener, requestChildDisplayer, requestChildDockTitle, updateTheme |
| Methods inherited from class bibliothek.gui.dock.dockable.AbstractDockable |
|---|
accept, 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, setController, setDockParent, 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.dock.station.OrientedDockStation |
|---|
setOrientation |
| Methods inherited from interface bibliothek.gui.DockStation |
|---|
accept, addDockStationListener, changed, drag, drop, drop, getController, getDirectActionOffers, getDockable, getDockableCount, getDockableProperty, getIndirectActionOffers, getLayers, getPlaceholders, getTheme, isChildShowing, isStationShowing, isStationVisible, isVisible, move, prepareDrop, removeDockStationListener, replace, requestChildDisplayer, requestChildDockTitle, setController, setPlaceholders, updateTheme |
| Methods inherited from interface bibliothek.gui.dock.DockElement |
|---|
asDockable, asDockStation, getFactoryID |
| 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, requestDockTitle, setController, setDockParent, unbind |
| Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative |
|---|
getElement, getPopupLocation, isUsedAsTitle, shouldFocus, shouldTransfersFocus |
| Methods inherited from interface bibliothek.gui.dock.station.support.PlaceholderListItem |
|---|
asDockable |
| Field Detail |
|---|
protected bibliothek.gui.dock.station.DisplayerCollection displayers
DockableDisplayers are set correctly
protected bibliothek.gui.dock.themes.DefaultDisplayerFactoryValue displayerFactory
displayers to create new
DockableDisplayers
protected bibliothek.gui.dock.title.DockTitleVersion title
DockTitles
protected bibliothek.gui.dock.themes.DefaultStationPaintValue paint
protected Orientation orientation
| Constructor Detail |
|---|
public AbstractToolbarDockStation()
init()
once the constructor has been executed.
| Method Detail |
|---|
protected abstract void init()
public bibliothek.gui.Dockable getFrontDockable()
getFrontDockable in interface bibliothek.gui.DockStationpublic void setFrontDockable(bibliothek.gui.Dockable dockable)
setFrontDockable in interface bibliothek.gui.DockStationpublic String toString()
toString in class Objectpublic int indexOf(bibliothek.gui.Dockable dockable)
dockable in the component-panel.
dockable - the Dockable to search
public Orientation getOrientation()
OrientedDockStation
getOrientation in interface OrientedDockStationpublic 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
nullprotected void fireOrientingEvent()
OrientingDockStationEvent.
public ExpandedState getExpandedState()
ExpandableToolbarItem
getExpandedState in interface ExpandableToolbarItem
@FrameworkOnly
public void setExpandedState(ExpandedState state,
boolean action)
ExpandedState of this station.
state - the new state, not nullaction - if true, then
setExpandedState(ExpandedState) is called. Otherwise
the property is changed without actually performing any
actions. The later option should only be used while loading a
layout.public void setExpandedState(ExpandedState state)
ExpandableToolbarItemstate.
setExpandedState in interface ExpandableToolbarItemstate - the new statepublic void stretch()
public void shrink()
public void addExpandableListener(ExpandableToolbarItemListener listener)
ExpandableToolbarItemlistener to this item.
addExpandableListener in interface ExpandableToolbarItemlistener - the new listener, not nullpublic void removeExpandableListener(ExpandableToolbarItemListener listener)
ExpandableToolbarItemlistener from this item.
removeExpandableListener in interface ExpandableToolbarItemlistener - the listener to removeprotected ExpandableToolbarItemListener[] expandableListeners()
ExpandableToolbarItemListeners that are currently
registered.
public ToolbarStrategy getToolbarStrategy()
ToolbarStrategy that is currently used by this station.
nullpublic boolean canDrag(bibliothek.gui.Dockable dockable)
canDrag in interface bibliothek.gui.DockStationprotected abstract void remove(bibliothek.gui.Dockable dockable)
dockable from this station.DockController.freezeLayout()
and DockController.meltLayout() to ensure none else adds or
removes Dockables.
dockable - the child to remove
public boolean canReplace(bibliothek.gui.Dockable old,
bibliothek.gui.Dockable next)
canReplace in interface bibliothek.gui.DockStation
public void replace(bibliothek.gui.DockStation old,
bibliothek.gui.Dockable next)
replace in interface bibliothek.gui.DockStationpublic bibliothek.gui.dock.station.StationDragOperation prepareDrag(bibliothek.gui.Dockable dockable)
prepareDrag in interface bibliothek.gui.DockStationprotected bibliothek.gui.Dockable getRemoval()
nullprotected abstract bibliothek.gui.dock.themes.DefaultDisplayerFactoryValue createDisplayerFactory()
DefaultDisplayerFactoryValue, a factory used to
create new DockableDisplayers.
nullpublic bibliothek.gui.dock.themes.DefaultStationPaintValue getPaint()
StationPaint which is used to paint some lines onto this
station. Use a delegate to exchange the paint.
protected abstract bibliothek.gui.dock.title.DockTitleVersion registerTitle(bibliothek.gui.DockController controller)
DockTitleFactory of this station at
controller and returns the associated
DockTitleVersion.
controller - the controller at which the default title factory has to be
registered
protected abstract void discard(bibliothek.gui.dock.station.DockableDisplayer displayer)
displayer with a new DockableDisplayer.
displayer - the displayer to replace
IllegalArgumentException - if displayer is not a child of this station
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||