Package | Description |
---|---|
bibliothek.gui |
The high level interfaces of the framework and the most often used classes.
|
bibliothek.gui.dock |
The five basic classes implementing
Dockable and
DockStation plus some supporting elements. |
bibliothek.gui.dock.common |
A set of classes that can be used to create basic applications.
|
bibliothek.gui.dock.common.grouping | |
bibliothek.gui.dock.common.location |
Various implementations of
CLocation . |
bibliothek.gui.dock.common.mode.station |
Contains wrapper classes for various
DockStation s, implementing the interface
CLocationMode . |
bibliothek.gui.dock.common.perspective.mode |
This module of the perspective API allows clients to access and modify
CDockable s that are in different modes like "maximized" or "minimized". |
bibliothek.gui.dock.facile.mode |
Contains an implementation of
ModeManager that links a mode to the location
of a Dockable . |
bibliothek.gui.dock.facile.mode.station |
Wrappers for
DockStation s, implementing StationModeArea . |
bibliothek.gui.dock.frontend |
Classes and interfaces needed by the
DockFrontend |
bibliothek.gui.dock.layout |
Elements dealing with the location of
Dockable s
on their DockStation and allowing to store the
whole layout of a set of Dockable s and stations. |
bibliothek.gui.dock.layout.location | |
bibliothek.gui.dock.perspective |
The perspective API allows clients to access and modify the layout without
actually creating any
Dockable s. |
bibliothek.gui.dock.station |
Elements needed by various implementations of the
DockStation interface. |
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 | Method and Description |
---|---|
DockableProperty |
DockStation.getDockableProperty(Dockable child,
Dockable target)
Gets precise information about the location of a child of this station.
|
DockableProperty |
DockFrontend.DockInfo.getLocation() |
Modifier and Type | Method and Description |
---|---|
boolean |
DockStation.drop(Dockable dockable,
DockableProperty property)
Tries to add
dockable to this station such that the location
given by property is matched. |
void |
DockStation.move(Dockable dockable,
DockableProperty property)
Tries to move the child
dockable in such a way, that
DockStation.getDockableProperty(Dockable, Dockable) would return a
DockableProperty that equals property .There is no need to give a guarantee that the move successes, and clients should always be prepared for the possibility that this DockStation
does nothing at all. |
void |
DockFrontend.DockInfo.setLocation(String root,
DockableProperty location) |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
FlapDockStation.getDockableProperty(Dockable dockable,
Dockable target) |
DockableProperty |
ScreenDockStation.getDockableProperty(Dockable dockable,
Dockable target) |
DockableProperty |
SplitDockStation.getDockableProperty(Dockable child,
Dockable target) |
DockableProperty |
StackDockStation.getDockableProperty(Dockable dockable,
Dockable target) |
Modifier and Type | Method and Description |
---|---|
boolean |
FlapDockStation.combine(Dockable child,
Dockable append,
DockableProperty property)
Creates a combination out of
child , which must be a
child of this station, and append which must not be
a child of this station. |
void |
ScreenDockStation.combine(Dockable lower,
Dockable upper,
DockableProperty property)
|
boolean |
FlapDockStation.drop(Dockable dockable,
DockableProperty property) |
boolean |
ScreenDockStation.drop(Dockable dockable,
DockableProperty property) |
boolean |
SplitDockStation.drop(Dockable dockable,
DockableProperty property) |
boolean |
StackDockStation.drop(Dockable dockable,
DockableProperty property) |
protected boolean |
SplitDockStation.dropOver(Leaf leaf,
Dockable dockable,
DockableProperty property,
CombinerSource source,
CombinerTarget target)
|
void |
FlapDockStation.move(Dockable dockable,
DockableProperty property) |
void |
ScreenDockStation.move(Dockable dockable,
DockableProperty property) |
void |
SplitDockStation.move(Dockable dockable,
DockableProperty property) |
void |
StackDockStation.move(Dockable dockable,
DockableProperty property) |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
CLocation.findProperty()
Gets a path describing this location in terms of the
DockingFrames.
|
abstract DockableProperty |
CLocation.findProperty(DockableProperty successor)
Gets a path describing this location in terms of the
DockingFrames.
|
Modifier and Type | Method and Description |
---|---|
CLocation |
CLocation.expandProperty(DockableProperty property,
CLocationExpandStrategy strategy)
Tries to create a location that resembles
property . |
CLocation |
CLocation.expandProperty(DockController controller,
DockableProperty property)
Tries to create a location that resembles
property . |
abstract DockableProperty |
CLocation.findProperty(DockableProperty successor)
Gets a path describing this location in terms of the
DockingFrames.
|
Modifier and Type | Method and Description |
---|---|
protected DockableProperty |
PlaceholderGrouping.getLocation(DockStation root)
Searches the ideal location on
root that matches the placeholder . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
CScreenDockStationHandle.External.getLocation(Dockable child) |
DockableProperty |
CScreenDockStationHandle.Maximal.getLocation(Dockable child) |
DockableProperty |
CSplitDockStationHandle.Normal.getLocation(Dockable child) |
DockableProperty |
CSplitDockStationHandle.Maximal.getLocation(Dockable child) |
DockableProperty |
ExternalizedCSplitDockStationHandler.Externalized.getLocation(Dockable child) |
Modifier and Type | Method and Description |
---|---|
boolean |
CScreenDockStationHandle.External.setLocation(Dockable dockable,
DockableProperty location,
AffectedSet set) |
boolean |
CSplitDockStationHandle.Normal.setLocation(Dockable dockable,
DockableProperty location,
AffectedSet set) |
boolean |
ExternalizedCSplitDockStationHandler.Externalized.setLocation(Dockable dockable,
DockableProperty location,
AffectedSet set) |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
LocationModeManagerPerspective.getMode(String root,
DockableProperty location)
Gets the mode which could have a child in the given location.
|
boolean |
CModeAreaPerspective.isChildLocation(DockableProperty location)
Tells whether
location could be the location of a child dockable of
this area. |
boolean |
AbstractModePerspective.isCurrentMode(String root,
DockableProperty location) |
boolean |
LocationModePerspective.isCurrentMode(String root,
DockableProperty location)
Checks whether the dockable at location
root /location
should be in the mode represented by this . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
Location.getLocation()
Gets the location on the parent station.
|
DockableProperty |
MaximizedModeArea.getLocation(Dockable child)
Gets the location of
dockable which is a child
of this station. |
DockableProperty |
StationModeArea.getLocation(Dockable child)
Gets the location of
dockable which is a child
of this station. |
Modifier and Type | Method and Description |
---|---|
boolean |
StationModeArea.setLocation(Dockable dockable,
DockableProperty location,
AffectedSet set)
Sets the location of
dockable to location
and tries to ensure that dockable is a child of this station.
This method may completely fail to change the location of dockable , for example because
a DockAcceptance does not allow the dockable to be moved. |
Constructor and Description |
---|
Location(Path mode,
String root,
DockableProperty location)
Creates a new location.
|
Location(Path mode,
String root,
DockableProperty location,
boolean applicationDefined)
Creates a new location.
|
Modifier and Type | Method and Description |
---|---|
DockableProperty |
FlapDockStationHandle.getLocation(Dockable child) |
Modifier and Type | Method and Description |
---|---|
boolean |
FlapDockStationHandle.setLocation(Dockable dockable,
DockableProperty location,
AffectedSet set) |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
DefaultLayoutChangeStrategy.SettingAccess.getInvisibleLocation(int index)
Gets the location of the index'th invisible element.
|
DockableProperty |
Setting.getInvisibleLocation(int index)
Gets the location of the index'th invisible element.
|
DockableProperty |
FrontendEntry.getLocation()
Gets the location of
the element which it had
the last time it was made invisible. |
Modifier and Type | Method and Description |
---|---|
protected Map<String,DockableProperty> |
DefaultLayoutChangeStrategy.listEstimateLocations(DockSituation situation,
DockLayoutComposition layout)
Tries to estimate the location of missing
Dockable s. |
Modifier and Type | Method and Description |
---|---|
void |
Setting.addInvisible(String key,
String root,
DockLayoutComposition layout,
DockableProperty location)
Stores the location of an invisible element.
|
void |
FrontendEntry.setLocation(String root,
DockableProperty location)
Sets the location of
the element . |
Modifier and Type | Class and Description |
---|---|
class |
AbstractDockableProperty
A simple implementation of
DockableProperty which provides
only the basic features. |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
DockableProperty.copy()
Gets a copy of this property, the
successor must be
copied as well. |
DockableProperty |
DockablePropertyFactory.createProperty()
Creates a new empty
DockableProperty . |
DockableProperty |
DockLayoutInfo.getLocation()
Gets the location of of the
Dockable on its parent station. |
DockableProperty |
AbstractDockableProperty.getSuccessor() |
DockableProperty |
DockableProperty.getSuccessor()
Gets the property which should be used for the child of this
dockable DockStation.
|
DockableProperty |
PropertyTransformer.read(DataInputStream in)
Reads a property which was earlier stored.
|
DockableProperty |
PropertyTransformer.readXML(XElement element)
Reads a
DockableProperty and its successors from an xml element. |
Modifier and Type | Method and Description |
---|---|
Map<String,DockableProperty> |
PredefinedDockSituation.listEstimatedLocations(DockLayoutComposition composition,
boolean missingOnly)
Lists for all keys that can be found in
composition its
estimated location.Note: This method will call DockSituation.estimateLocations(DockLayoutComposition)
to get the most recent locations |
Map<String,DockableProperty> |
PredefinedDockSituation.listEstimatedLocations(DockLayoutComposition composition,
DockableProperty location,
boolean missingOnly)
Lists for all keys that can be found in
composition its
estimated location.Note: This method will call DockSituation.estimateLocations(DockLayoutComposition)
to get the most recent locations |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractDockableProperty.equalsNoSuccessor(DockableProperty property) |
boolean |
DockableProperty.equalsNoSuccessor(DockableProperty property)
|
void |
DockSituation.estimateLocations(DockLayoutComposition composition,
DockableProperty location)
Tries to guess the location of the elements stored in the tree below
composition , assuming that composition itself
is at location location . |
Map<String,DockableProperty> |
PredefinedDockSituation.listEstimatedLocations(DockLayoutComposition composition,
DockableProperty location,
boolean missingOnly)
Lists for all keys that can be found in
composition its
estimated location.Note: This method will call DockSituation.estimateLocations(DockLayoutComposition)
to get the most recent locations |
void |
DockLayoutInfo.setLocation(DockableProperty location)
Sets the location of the
Dockable ,represented by this info,
on its parent station. |
void |
DefaultLocationEstimationMap.setLocation(int childIndex,
DockableProperty location) |
void |
LocationEstimationMap.setLocation(int childIndex,
DockableProperty location)
Informs this map that the jump from this station to
childIndex can be described
by location . |
void |
DefaultLocationEstimationMap.setLocation(int childIndex,
int subChildIndex,
DockableProperty location) |
void |
LocationEstimationMap.setLocation(int childIndex,
int subChildIndex,
DockableProperty location)
Informs this map that the path to child
childIndex, subChildIndex contains
location . |
void |
AbstractDockableProperty.setSuccessor(DockableProperty properties) |
void |
DockableProperty.setSuccessor(DockableProperty properties)
Sets the property which will be used if this property was used and
there is not yet a leaf in the tree of DockStations and Dockables reached.
For example: there is a DockStation root , a
dockable DockStation node which is a child of root
and a Dockable leaf which is a child of node .A DockableProperty called one would describe the relationship
between root and node . |
void |
PropertyTransformer.write(DockableProperty property,
DataOutputStream out)
Writes
property and all its successors into out . |
void |
PropertyTransformer.writeXML(DockableProperty property,
XElement element)
Writes
property and all its successors into
element . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
AsideAnswer.getLocation()
Gets the location generated by the child station.
|
DockableProperty |
AsideRequest.getLocation()
Gets the old location, the location whose neighbor is searched.
|
DockableProperty |
DefaultAsideAnswer.getLocation() |
DockableProperty |
DefaultAsideRequest.getLocation() |
Modifier and Type | Method and Description |
---|---|
void |
AsideRequest.answer(DockableProperty location)
Sets the result of this request,
location will be merged with other
results from the parent and children stations using the
successor property. |
void |
DefaultAsideRequest.answer(DockableProperty location) |
void |
AsideRequest.answer(DockableProperty location,
PlaceholderMap station)
Sets the result of this request, and tells how the layout of a non-existent stations looks after the request
has been handled.
|
void |
DefaultAsideRequest.answer(DockableProperty location,
PlaceholderMap station) |
AsideRequest |
AsideRequestFactory.createAsideRequest(DockableProperty location,
Dockable dockable)
Creates a new
AsideRequest for dockable . |
AsideRequest |
DefaultAsideRequestFactory.createAsideRequest(DockableProperty location,
Dockable dockable) |
protected DefaultAsideRequest |
DefaultAsideRequest.createForwardRequest(DockableProperty location)
Creates a new
AsideRequest which is used to examine the next child DockStation . |
Constructor and Description |
---|
DefaultAsideAnswer(boolean canceled,
DockableProperty location,
PlaceholderMap layout)
Creates a new answer.
|
DefaultAsideRequest(DockableProperty location,
Path placeholder)
Creates a new
AsideRequest |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
PerspectiveStation.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target)
Gets precise information about the location of a child of this station.
|
Modifier and Type | Method and Description |
---|---|
DockableProperty |
PlaceholderMapping.getLocationAt(Path placeholder)
Gets a
DockableProperty that describes the location of placeholder . |
Modifier and Type | Class and Description |
---|---|
class |
FlapDockProperty
FlapDockProperties are used on the
FlapDockStation to determine
the location of a Dockable . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
FlapDockPropertyFactory.createProperty() |
DockableProperty |
FlapDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
Modifier and Type | Class and Description |
---|---|
class |
ScreenDockProperty
This property is used on
ScreenDockStations
to determine the bounds of the dialogs . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
ScreenDockPropertyFactory.createProperty() |
DockableProperty |
ScreenDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
Modifier and Type | Class and Description |
---|---|
class |
SplitDockFullScreenProperty
This
DockableProperty points to the currently maximized child of a SplitDockStation . |
class |
SplitDockPathProperty
A
DockableProperty used by the SplitDockStation to describe
the location of a Dockable in the tree of all children of the station. |
class |
SplitDockPlaceholderProperty
This property references a placeholder that is already present within the
tree of a
SplitDockStation . |
class |
SplitDockProperty
This property stores the location and the size of each child of a
SplitDockStation . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
SplitDockFullScreenProperty.copy() |
DockableProperty |
SplitDockPathProperty.copy() |
DockableProperty |
SplitDockProperty.copy() |
DockableProperty |
SplitDockFullScreenPropertyFactory.createProperty() |
DockableProperty |
SplitDockPathPropertyFactory.createProperty() |
DockableProperty |
SplitDockPlaceholderPropertyFactory.createProperty() |
DockableProperty |
SplitDockPropertyFactory.createProperty() |
DockableProperty |
SplitDockPlaceholderProperty.getBackup()
Gets the backup location that was set when this
SplitDockPlaceholderProperty
was created. |
DockableProperty |
SplitDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
DockableProperty |
SplitDockPlaceholderMapping.getLocationAt(Path placeholder) |
DockableProperty |
SplitDockPlaceholderProperty.toLocation(SplitNode target)
Gets some
DockableProperty that works as backup property
if the referenced placeholder is not found. |
Modifier and Type | Method and Description |
---|---|
void |
SplitDockPlaceholderProperty.setSuccessor(DockableProperty successor) |
Modifier and Type | Class and Description |
---|---|
class |
StackDockProperty
A StackDockProperty stores the location of a
Dockable
on a StackDockStation . |
Modifier and Type | Method and Description |
---|---|
DockableProperty |
StackDockProperty.copy() |
DockableProperty |
StackDockPropertyFactory.createProperty() |
DockableProperty |
StackDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
Modifier and Type | Method and Description |
---|---|
static DockableProperty |
DockUtilities.append(DockableProperty root,
DockableProperty property)
Creates a copy of
root and sets property
as the successor of the very last element in the property chain beginning
at root . |
static DockableProperty |
DockUtilities.getLastProperty(DockableProperty property)
Gets the last successor in the property chain beginning at
property . |
static DockableProperty |
DockUtilities.getPropertyChain(Dockable dockable)
|
static DockableProperty |
DockUtilities.getPropertyChain(DockStation ground,
Dockable dockable)
|
static DockableProperty |
DockUtilities.getPropertyChain(PerspectiveStation ground,
PerspectiveDockable dockable)
|
Modifier and Type | Method and Description |
---|---|
static DockableProperty |
DockUtilities.append(DockableProperty root,
DockableProperty property)
Creates a copy of
root and sets property
as the successor of the very last element in the property chain beginning
at root . |
static DockableProperty |
DockUtilities.getLastProperty(DockableProperty property)
Gets the last successor in the property chain beginning at
property . |