| Package | Description |
|---|---|
| bibliothek.gui.dock |
The five basic classes implementing
Dockable and
DockStation plus some supporting elements. |
| bibliothek.gui.dock.dockable |
Some classes related to
Dockable. |
| bibliothek.gui.dock.frontend |
Classes and interfaces needed by the
DockFrontend |
| bibliothek.gui.dock.layout |
Elements dealing with the location of
Dockables
on their DockStation and allowing to store the
whole layout of a set of Dockables and stations. |
| bibliothek.gui.dock.perspective |
The perspective API allows clients to access and modify the layout without
actually creating any
Dockables. |
| bibliothek.gui.dock.station.flap |
Elements that are related to the
FlapDockStation. |
| bibliothek.gui.dock.station.screen |
Elements that are related to the
ScreenDockStation. |
| bibliothek.gui.dock.station.split |
Elements which are needed by the
SplitDockStation,
and which are needed to interact with the station. |
| bibliothek.gui.dock.station.stack |
Elements which are related to the
StackDockStation. |
| bibliothek.gui.dock.util |
Distribution of information in a global scale and methods available from
everywhere.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
DockFactory<D extends DockElement,P extends PerspectiveElement,L>
A
DockConverter which can not only store and load the contents of an
element, but also create a new DockElement with the content. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultDockablePerspective
Implementation of a
PerspectiveElement that represents a DefaultDockable. |
| Modifier and Type | Class and Description |
|---|---|
class |
RegisteringDockFactory<D extends Dockable,P extends PerspectiveElement,L>
A
DockFactory that wraps around another factory and adds all elements
that are read through RegisteringDockFactory.layout(BackupFactoryData, PlaceholderStrategy) or RegisteringDockFactory.layout(BackupFactoryData, Map, PlaceholderStrategy)
to a DockFrontend. |
| Modifier and Type | Class and Description |
|---|---|
class |
FrontendDockablePerspective
This
DefaultDockablePerspective represents a DefaultDockable that was added
to a DockFrontend with a unique identifier. |
| Modifier and Type | Method and Description |
|---|---|
PerspectiveElement |
FrontendPerspectiveCache.get(String id,
boolean rootStation)
Called to convert
id to a PerspectiveElement. |
PerspectiveElement |
DefaultFrontendPerspectiveCache.get(String id,
boolean rootStation) |
PerspectiveElement |
FrontendPerspectiveCache.get(String id,
DockElement element,
boolean isRootStation)
Given an
element that was earlier created by the client and added to a
DockFrontend, this method converts element to a PerspectiveElement.When called multiple times with the same arguments, then this method is free to either return different objects or to always return the same object. |
PerspectiveElement |
DefaultFrontendPerspectiveCache.get(String id,
DockElement element,
boolean isRootStation) |
PerspectiveElement |
FrontendPerspectiveCacheExtension.get(String id,
DockElement element,
boolean isRootStation)
Converts
element into a PerspectiveElement. |
| Modifier and Type | Method and Description |
|---|---|
String |
FrontendPerspectiveCache.get(PerspectiveElement element)
Gets the unique identifier of
element. |
String |
DefaultFrontendPerspectiveCache.get(PerspectiveElement element) |
String |
FrontendPerspectiveCacheExtension.get(PerspectiveElement element)
Gets the unique identifier of
element. |
protected void |
DefaultFrontendPerspectiveCache.put(PerspectiveElement element,
String id)
Makes an association that the identifier
id is used for element. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
DockConverter<D extends DockElement,P extends PerspectiveElement,L>
A
DockConverter can store or load content which is related
to a certain kind of DockElement.The content of an element is first converted in a special intermediate form represented by some object of type L. |
| Modifier and Type | Method and Description |
|---|---|
protected String |
DockSituation.getID(PerspectiveElement element)
Gets the id of the factory which is needed to write (and later
read)
element |
protected String |
PredefinedDockSituation.getID(PerspectiveElement element,
PredefinedPerspective perspective)
Gets the identifier that matches
element which is part of perspective. |
boolean |
DockSituationIgnore.ignoreElement(PerspectiveElement element)
Tells whether to ignore this element when saving.
|
boolean |
AdjacentDockFactory.interested(PerspectiveElement element)
Tells whether this factory is interested in storing information for
element. |
protected boolean |
PredefinedDockSituation.shouldLayout(PerspectiveElement element,
PredefinedPerspective perspective)
Tells whether the layout of
element itself should be stored
or loaded, that will not prevent the element from showing
up but from changing its content. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
PerspectiveDockable
A representation of a
Dockable in a Perspective. |
interface |
PerspectiveStation
An abstract representation of a
DockStation in a Perspective. |
| Modifier and Type | Method and Description |
|---|---|
PerspectiveElement |
Perspective.convert(DockLayoutComposition composition)
Converts
composition using the DockFactorys that are registered at
this perspective. |
PerspectiveElement |
PredefinedPerspective.get(String key)
Gets the element which was stored using
key. |
PerspectiveElement |
PredefinedMap.get(String id)
Given a unique identifier
id, tells what PerspectiveElement belongs to that id. |
| Modifier and Type | Method and Description |
|---|---|
DockLayoutComposition |
Perspective.convert(PerspectiveElement element)
Converts
element using the DockFactorys that are registered at this
perspective. |
String |
PredefinedPerspective.get(PerspectiveElement element)
Gets the key for
element. |
String |
PredefinedMap.get(PerspectiveElement element)
Given
element, tells what unique identifier element has. |
protected abstract String |
Perspective.getID(PerspectiveElement element)
Gets the identifier of the factory that is responsible for
element. |
void |
PredefinedPerspective.put(String key,
PerspectiveElement element)
Registers
element on this PredefinedPerspective. |
| Modifier and Type | Class and Description |
|---|---|
class |
FlapDockPerspective
A representation of a
FlapDockStation in a Perspective.Note: while this perspective allows to set the hold and size
property of a dockable, the final decision of how these properties look like are made
by the FlapLayoutManager that is installed on the FlapDockStation which shows
the real Dockables. |
| Modifier and Type | Class and Description |
|---|---|
class |
ScreenDockPerspective
A representation of a
ScreenDockStation in a Perspective. |
| Modifier and Type | Class and Description |
|---|---|
class |
SplitDockPerspective
Represents a
SplitDockStation in a Perspective. |
| Modifier and Type | Class and Description |
|---|---|
class |
StackDockPerspective
A representation of a
StackDockStation in a Perspective. |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
DockUtilities.isAncestor(PerspectiveElement ancestor,
PerspectiveElement child)
Tells whether
child is identical with ancestor
or a child of ancestor. |
Copyright © 2017 Docking Frames. All rights reserved.