Package | Description |
---|---|
bibliothek.gui.dock.common |
A set of classes that can be used to create basic applications.
|
bibliothek.gui.dock.common.action |
Contains different
DockAction s and subclasses of CAction to
create buttons, checkboxes, menus and other components as button in the titles and tabs of
CDockable s. |
bibliothek.gui.dock.common.action.predefined |
A set of more complex actions that can be directly used.
|
bibliothek.gui.dock.common.behavior | |
bibliothek.gui.dock.common.event | |
bibliothek.gui.dock.common.intern |
Classes and interfaces used internally.
|
bibliothek.gui.dock.common.intern.action |
CAction s and supporting classes that are not intended for clients
to be used directly. |
bibliothek.gui.dock.common.intern.color |
Various implementations of
ColorBridge used by the themes of Common
to transfer colors from the ColorMap of CDockable s
through the ColorManager to the Component s which are related
to said dockable s. |
bibliothek.gui.dock.common.intern.font |
Various implementations of
FontBridge to transfer
fonts stored in a FontMap . |
bibliothek.gui.dock.common.intern.station |
Contains the
CommonDockStation , various implementations of CommonDockStation and supporting classes. |
bibliothek.gui.dock.common.intern.ui |
Base-classes intended for inheritance and small strategy-classes modifying the way
Core works. |
bibliothek.gui.dock.common.mode | |
bibliothek.gui.dock.common.util | |
bibliothek.gui.dock.facile.action |
Some
DockAction s used by Common . |
Modifier and Type | Interface and Description |
---|---|
interface |
MultipleCDockable
|
interface |
SingleCDockable
A
SingleCDockable is a dockable which is added once to
the CControl and remains there until it is removed by the application. |
Modifier and Type | Class and Description |
---|---|
class |
CGridArea
|
class |
CWorkingArea
A working area is an element which is always visible and contains some
CDockable s which can't be dragged out of it. |
class |
DefaultMultipleCDockable
A
MultipleCDockable that contains a content-pane
where the client might add or remove as many Component s as
it wishes. |
class |
DefaultSingleCDockable
A
DefaultSingleCDockable is an element which has a
content-pane where clients can add or remove as many
Component s as they whish. |
Modifier and Type | Method and Description |
---|---|
CDockable |
CGridArea.asDockable() |
CDockable |
CMinimizeArea.asDockable() |
CDockable |
CStation.asDockable()
|
CDockable |
CControl.getCDockable(int index)
Gets the index'th dockable that is registered in this control
|
CDockable |
ColorMap.getDockable()
Gets the owner of this map.
|
CDockable |
FontMap.getDockable()
Gets the owner of this map.
|
CDockable |
CControlRegister.getDockable(int index)
Gets the index'th dockable that is registered
|
CDockable |
CFocusHistory.getFirst(Filter<CDockable> filter)
Gets the first
CDockable matching filter . |
CDockable |
DefaultCFocusHistory.getFirst(Filter<CDockable> filter) |
CDockable |
CControl.getFocusedCDockable()
Gets the currently focused
CDockable . |
CDockable[] |
CFocusHistory.getHistory()
Gets the entire history of focused
CDockable s, the most recent focused dockable
is at the beginning of the array. |
CDockable[] |
DefaultCFocusHistory.getHistory() |
Modifier and Type | Method and Description |
---|---|
java.util.List<CDockable> |
CControlRegister.getDockables()
Gets an unmodifiable list of all
CDockable s which are known to
this register. |
java.util.List<CDockable> |
CControlRegister.listDockablesInMode(ExtendedMode mode)
Gets a list of all visible
CDockable s in the given mode. |
Modifier and Type | Method and Description |
---|---|
void |
CGrid.add(double x,
double y,
double width,
double height,
CDockable... dockables)
Adds a new set of
CDockable s to this grid. |
void |
CGrid.select(double x,
double y,
double width,
double height,
CDockable dockable)
Marks
dockable as being selected in the stack that
has the boundaries of x, y, width, height . |
Modifier and Type | Method and Description |
---|---|
CDockable |
CFocusHistory.getFirst(Filter<CDockable> filter)
Gets the first
CDockable matching filter . |
CDockable |
DefaultCFocusHistory.getFirst(Filter<CDockable> filter) |
Constructor and Description |
---|
ColorMap(CDockable dockable)
Creates a new map.
|
FontMap(CDockable dockable)
Creates a new map
|
Modifier and Type | Method and Description |
---|---|
CAction |
CloseActionFactory.create(CControl control,
CDockable dockable)
Creates a new action.
|
Modifier and Type | Method and Description |
---|---|
void |
CCloseAction.close(CDockable dockable)
Closes
dockable now. |
Modifier and Type | Class and Description |
---|---|
class |
ExternalizingCGridArea
|
Modifier and Type | Method and Description |
---|---|
CDockable |
CDockableLocationEvent.getDockable()
Gets the dockable whose state changed.
|
CDockable |
CVetoClosingEvent.getDockable(int index)
Gets the
index 'th dockable that is associated with this event. |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<CDockable> |
CVetoClosingEvent.iterator() |
Modifier and Type | Method and Description |
---|---|
void |
CDockableAdapter.actionChanged(CDockable dockable,
java.lang.String key,
CAction oldAction,
CAction newAction) |
void |
CDockablePropertyListener.actionChanged(CDockable dockable,
java.lang.String key,
CAction oldAction,
CAction newAction)
Called when an action that is returned by
getAction(String)
has been exchanged. |
void |
CControlListener.added(CControl control,
CDockable dockable)
Called when
dockable has been made public. |
boolean |
CDoubleClickListener.clicked(CDockable source,
java.awt.event.MouseEvent event)
Called when a double click happened.
|
void |
CDockableAdapter.closeableChanged(CDockable dockable) |
void |
CDockablePropertyListener.closeableChanged(CDockable dockable)
Called when the
closeable -property has
changed. |
void |
CControlListener.closed(CControl control,
CDockable dockable)
Called when
dockable has been made invisible. |
void |
CDockableAdapter.enabledChanged(CDockable dockable) |
void |
CDockablePropertyListener.enabledChanged(CDockable dockable)
Called if the result of
isEnabled(bibliothek.gui.dock.common.EnableableItem) changed
for any argument. |
void |
CDockableAdapter.extendedModeChanged(CDockable dockable,
ExtendedMode mode) |
void |
CDockableStateListener.extendedModeChanged(CDockable dockable,
ExtendedMode mode)
Called if the
extended mode of dockable
changed. |
void |
CDockableAdapter.externalizableChanged(CDockable dockable) |
void |
CDockablePropertyListener.externalizableChanged(CDockable dockable)
Called when the
externalizable -property
has changed. |
void |
CDockableAdapter.externalized(CDockable dockable)
Called when the
dockable has been externalized. |
void |
CFocusListener.focusGained(CDockable dockable)
Called when
dockable gains the focus. |
void |
CFocusListener.focusLost(CDockable dockable)
Called when
dockable lost its focus. |
boolean |
CKeyboardListener.keyPressed(CDockable source,
java.awt.event.KeyEvent event)
Called when a key was pressed on a child or on
source . |
boolean |
CKeyboardListener.keyReleased(CDockable source,
java.awt.event.KeyEvent event)
Called when a key was released on a child or on
source . |
boolean |
CKeyboardListener.keyTyped(CDockable source,
java.awt.event.KeyEvent event)
Called when a key was typed on a child or on
source . |
void |
CDockableAdapter.maximizableChanged(CDockable dockable) |
void |
CDockablePropertyListener.maximizableChanged(CDockable dockable)
Called when the
maximizable -property
has changed. |
void |
CDockableAdapter.maximized(CDockable dockable)
Called when the
dockable has been maximized. |
void |
CDockableAdapter.minimizableChanged(CDockable dockable) |
void |
CDockablePropertyListener.minimizableChanged(CDockable dockable)
Called when the
minimizable -property
has changed. |
void |
CDockableAdapter.minimized(CDockable dockable)
Called when the
dockable has been minimized. |
void |
CDockableAdapter.minimizeSizeChanged(CDockable dockable) |
void |
CDockablePropertyListener.minimizeSizeChanged(CDockable dockable)
Called when the property
getMinimizedSize() has changed. |
void |
CDockableAdapter.modeChanged(CDockable dockable,
ExtendedMode mode)
Called by
CDockableAdapter.extendedModeChanged(CDockable, ExtendedMode) if none of the
default modes was selected |
void |
CDockableAdapter.normalizeableChanged(CDockable dockable) |
void |
CDockablePropertyListener.normalizeableChanged(CDockable dockable)
Called when the
isNormalizeable() -property has changed. |
void |
CDockableAdapter.normalized(CDockable dockable)
Called when the
dockable has been normalized. |
void |
CControlListener.opened(CControl control,
CDockable dockable)
Called when
dockable has been made visible. |
void |
CControlListener.removed(CControl control,
CDockable dockable)
Called when
dockable has been removed. |
void |
CDockableAdapter.resizeLockedChanged(CDockable dockable) |
void |
CDockablePropertyListener.resizeLockedChanged(CDockable dockable)
Called when the
isResizeLockedHorizontally() or
isResizeLockedVertically() -property has changed. |
void |
CDockableAdapter.singleTabShownChanged(CDockable dockable) |
void |
CDockablePropertyListener.singleTabShownChanged(CDockable dockable)
Called when the property
isSingleTabShown() has changed. |
void |
CDockableAdapter.stickyChanged(CDockable dockable) |
void |
CDockablePropertyListener.stickyChanged(CDockable dockable)
Called when the
isSticky() -property has changed. |
void |
CDockableAdapter.stickySwitchableChanged(CDockable dockable) |
void |
CDockablePropertyListener.stickySwitchableChanged(CDockable dockable)
Called when the property
isStickySwitchable() has changed. |
void |
CDockableAdapter.titleShownChanged(CDockable dockable) |
void |
CDockablePropertyListener.titleShownChanged(CDockable dockable)
Called when the property
isTitleShown() has changed. |
void |
CDockableAdapter.visibilityChanged(CDockable dockable) |
void |
CDockableStateListener.visibilityChanged(CDockable dockable)
Called when the
visibility -property
changed. |
boolean |
CVetoFocusListener.willGainFocus(CDockable dockable)
Called before focus is transferred to
dockable . |
boolean |
CVetoFocusListener.willLoseFocus(CDockable dockable)
Called before focus is transferred from
dockable . |
Constructor and Description |
---|
CDockableLocationEvent(CDockable dockable,
boolean oldShowing,
boolean newShowing,
CLocation oldLocation,
CLocation newLocation)
Creates a new event.
|
CVetoClosingEvent(CControl control,
VetoableDockFrontendEvent source,
CDockable... dockables)
Creates a new event.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractCDockable
An abstract implementation of
CDockable . |
class |
AbstractDockableCStation<S extends CommonDockStation<?,?>>
|
class |
DefaultCDockable
An
CDockable that uses a DefaultCommonDockable to show
its content.Subclasses may override DefaultCDockable.createCommonDockable() to provide a custom subclass
of DefaultCommonDockable , note that DefaultCDockable.createCommonDockable() is called
as soon as the internal representation is required, e.g. |
Modifier and Type | Method and Description |
---|---|
CDockable |
AbstractCStation.asDockable() |
CDockable |
AbstractDockableCStation.asDockable() |
protected CDockable[] |
ControlVetoClosingListener.getCDockables(VetoableDockFrontendEvent event)
Gets all the
CDockable s that are to be forwarded by this converter. |
CDockable |
CommonDockable.getDockable()
Gets the model of this dockable.
|
CDockable |
DefaultCommonDockable.getDockable() |
CDockable |
DefaultCControlRegister.getDockable(int index) |
Modifier and Type | Method and Description |
---|---|
java.util.List<CDockable> |
DefaultCControlRegister.getDockables() |
java.util.List<CDockable> |
DefaultCControlRegister.listDockablesInMode(ExtendedMode mode)
Gets a list of all visible
CDockable s in the given mode. |
Modifier and Type | Method and Description |
---|---|
CDockableAccess |
CControlAccess.access(CDockable dockable)
Grants access to the internal methods of a
CDockable . |
DockAction |
CControlAccess.createCloseAction(CDockable dockable)
Gets an action that closes
dockable when clicked. |
CLocation |
CControlAccess.getAutoBaseLocation(CDockable dockable,
boolean noBackwardTransformation)
Gets the default result for
getAutoBaseLocation(boolean) . |
boolean |
CControlAccess.hasParent(CDockable dockable)
Tells whether
dockable has a parent and is registered. |
void |
CControlAccess.hide(CDockable dockable)
Makes
dockable invisible. |
boolean |
CControlAccess.isVisible(CDockable dockable)
Tells whether
dockable is visible or not. |
boolean |
CancelDragAndDropOperation.keyPressed(CDockable source,
java.awt.event.KeyEvent event) |
boolean |
CancelDragAndDropOperation.keyReleased(CDockable source,
java.awt.event.KeyEvent event) |
boolean |
CancelDragAndDropOperation.keyTyped(CDockable source,
java.awt.event.KeyEvent event) |
void |
CControlAccess.link(CDockable dockable,
CDockableAccess access)
Gives or removes access to internal properties of an
CDockable . |
void |
AbstractCDockable.setLocationsAside(CDockable dockable) |
void |
CDockable.setLocationsAside(CDockable dockable)
|
java.lang.String |
CControlAccess.shouldStore(CDockable dockable)
Tells whether information about
dockable should remain stored even if
the element is removed from the CControl . |
void |
CControlAccess.show(CDockable dockable)
Makes
dockable visible. |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractCDockable.setLocationsAside(Filter<CDockable> filter) |
boolean |
CDockable.setLocationsAside(Filter<CDockable> filter)
Traverses the history of focused
CDockable s, and selects the newest item with focus and matching
filter for calling setLocationsAside(CDockable) . |
Constructor and Description |
---|
CDockableLocationListenerManager(CDockable dockable)
Creates a new manager
|
DefaultCommonDockable(CDockable dockable,
DockActionSource... sources)
Creates a new dockable
|
DelayedWorkingAreaSetter(java.lang.String area,
CDockable dockable,
CControl control)
Creates a new setter.
|
Modifier and Type | Method and Description |
---|---|
void |
CExtendedModeAction.action(CDockable dockable)
This method actually changes the
ExtendedMode of dockable
to the mode that was given to this action in the constructor. |
Constructor and Description |
---|
CloseActionSource(CDockable dockable)
Creates a new source
|
Modifier and Type | Method and Description |
---|---|
protected CDockable |
BubbleDisplayerTransmitter.getDockable(DockColor observer) |
protected CDockable |
MinimizedButtonColorTransmitter.getDockable(DockColor observer) |
protected CDockable |
TabColorTransmitter.getDockable(DockColor observer) |
protected CDockable |
TitleColorTransmitter.getDockable(DockColor observer) |
Modifier and Type | Method and Description |
---|---|
protected void |
ColorTransmitter.connect(CDockable dockable) |
protected void |
ColorTransmitter.disconnect(CDockable dockable) |
protected java.awt.Color |
BubbleDisplayerTransmitter.get(java.awt.Color color,
java.lang.String id,
CDockable dockable)
Searches for a color that fits for the color with name
id . |
protected java.awt.Color |
MinimizedButtonColorTransmitter.get(java.awt.Color color,
java.lang.String id,
CDockable dockable)
Searches the color
id for dockable . |
protected java.awt.Color |
TabColorTransmitter.get(java.awt.Color color,
java.lang.String id,
CDockable dockable)
Searches the color
id for dockable . |
protected java.awt.Color |
TitleColorTransmitter.get(java.awt.Color color,
java.lang.String id,
CDockable dockable)
Searches the color
id for dockable . |
protected void |
BubbleDisplayerTransmitter.update(CDockable dockable,
java.lang.String key,
java.awt.Color color) |
protected void |
MinimizedButtonColorTransmitter.update(CDockable dockable,
java.lang.String key,
java.awt.Color color) |
protected void |
TabColorTransmitter.update(CDockable dockable,
java.lang.String key,
java.awt.Color color) |
protected void |
TitleColorTransmitter.update(CDockable dockable,
java.lang.String key,
java.awt.Color color) |
Modifier and Type | Method and Description |
---|---|
protected CDockable |
ButtonFontTransmitter.getDockable(DockFont observer) |
protected CDockable |
TabFontTransmitter.getDockable(DockFont observer) |
protected CDockable |
TabTitleFontTransmitter.getDockable(DockFont observer) |
protected CDockable |
TitleFontTransmitter.getDockable(DockFont observer) |
Modifier and Type | Method and Description |
---|---|
protected void |
FontTransmitter.connect(CDockable dockable) |
protected void |
FontTransmitter.disconnect(CDockable dockable) |
protected abstract FontModifier |
FontTransmitter.get(FontModifier value,
java.lang.String id,
CDockable dockable)
Transforms
value into the form that should be used together
with dockable . |
protected FontModifier |
ListFontTransmitter.get(FontModifier value,
java.lang.String id,
CDockable dockable) |
protected void |
FontTransmitter.update(CDockable dockable,
java.lang.String key,
FontModifier value) |
Modifier and Type | Method and Description |
---|---|
CDockable |
CFlapDockStation.getDockable() |
CDockable |
CSplitDockStation.getDockable() |
CDockable |
CommonStationDelegate.getDockable()
Gets a result for
CommonDockable.getDockable() . |
Modifier and Type | Method and Description |
---|---|
protected abstract CDockable |
UITransmitter.getDockable(U observer)
Gets the
CDockable which is associated with observer . |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
UITransmitter.connect(CDockable dockable)
Adds a listener to
dockable and calls
UITransmitter.update(CDockable, String, Object) whenever some value
needs an update. |
protected abstract void |
UITransmitter.disconnect(CDockable dockable)
Removes a listener from
dockable . |
protected void |
UITransmitter.set(java.lang.String id,
V value,
CDockable dockable)
Transmits
value to all UIValue s which
listen to the given id and which are associated with dockable . |
protected abstract void |
UITransmitter.update(CDockable dockable,
java.lang.String key,
V value)
Called when a value in an observed map has changed.
|
Modifier and Type | Method and Description |
---|---|
void |
CLocationModeManager.ensureValidLocation(CDockable dockable)
This method compares the current mode of
dockable with its
availability set. |
Modifier and Type | Method and Description |
---|---|
static CDockable |
CDockUtilities.getFirstDockable(DockElement element)
Searches a
CDockable in the tree starting with element . |
Constructor and Description |
---|
KeyedActionSource(CDockable dockable,
java.lang.String key)
Creates a new action source
|