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.perspective |
The perspective API offers clients the possibility to define or modify the layout
of an application without actually creating any
CDockable s. |
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.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.station.support |
Elements used by various
DockStation s to store
properties and to propagate events to other objects. |
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
DockStation.getPlaceholders()
Gets a snapshot of all placeholders that are currently stored in this
DockStation . |
Modifier and Type | Method and Description |
---|---|
void |
DockStation.setPlaceholders(PlaceholderMap placeholders)
Sets an earlier snapshot of the placeholders of this station.
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
FlapDockStation.getPlaceholders() |
PlaceholderMap |
ScreenDockStation.getPlaceholders() |
PlaceholderMap |
SplitDockStation.getPlaceholders() |
PlaceholderMap |
StackDockStation.getPlaceholders() |
PlaceholderMap |
FlapDockStation.getPlaceholders(Map<Dockable,Integer> children)
Gets the placeholders of this station using a
PlaceholderListItemConverter to
encode the children of this station. |
PlaceholderMap |
ScreenDockStation.getPlaceholders(Map<Dockable,Integer> children)
Gets the placeholders of this station using a
PlaceholderListItemConverter to
encode the children of this station. |
PlaceholderMap |
StackDockStation.getPlaceholders(Map<Dockable,Integer> children)
Gets the placeholders of this station using a
PlaceholderListItemConverter to
encode the children of this station. |
Modifier and Type | Method and Description |
---|---|
void |
FlapDockStation.setPlaceholders(PlaceholderMap placeholders) |
void |
ScreenDockStation.setPlaceholders(PlaceholderMap placeholders) |
void |
SplitDockStation.setPlaceholders(PlaceholderMap placeholders) |
void |
StackDockStation.setPlaceholders(PlaceholderMap placeholders) |
void |
FlapDockStation.setPlaceholders(PlaceholderMap map,
Map<Integer,Dockable> children)
Sets a new layout on this station, this method assumes that
map was created
using FlapDockStation.getPlaceholders(Map) . |
void |
ScreenDockStation.setPlaceholders(PlaceholderMap map,
Map<Integer,Dockable> children)
Sets a new layout on this station, this method assumes that
map was created
using ScreenDockStation.getPlaceholders(Map) . |
void |
StackDockStation.setPlaceholders(PlaceholderMap placeholders,
Map<Integer,Dockable> children)
Sets all placeholders and children of this station.
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
CExternalizePerspective.getPlaceholders() |
PlaceholderMap |
CGridPerspective.getPlaceholders() |
PlaceholderMap |
CMinimizePerspective.getPlaceholders() |
Modifier and Type | Method and Description |
---|---|
void |
CExternalizePerspective.setPlaceholders(PlaceholderMap placeholders) |
void |
CGridPerspective.setPlaceholders(PlaceholderMap placeholders) |
void |
CMinimizePerspective.setPlaceholders(PlaceholderMap placeholders) |
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
AsideAnswer.getLayout()
Gets the layout of a non-existent child station.
|
PlaceholderMap |
AsideRequest.getLayout()
Gets the layout of the current non-existent station.
|
PlaceholderMap |
DefaultAsideAnswer.getLayout() |
PlaceholderMap |
DefaultAsideRequest.getLayout() |
PlaceholderMap |
DefaultAsideRequest.Forward.getLayout()
Gets the layout of the current station.
|
PlaceholderMap |
DefaultAsideRequest.DockStationForward.getLayout() |
PlaceholderMap |
DefaultAsideRequest.CombinerForward.getLayout() |
Modifier and Type | Method and Description |
---|---|
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) |
void |
AsideRequest.answer(PlaceholderMap station)
Tells this request how the layout of a non-existent station looks after the request has been handled.
|
void |
DefaultAsideRequest.answer(PlaceholderMap station) |
AsideAnswer |
AsideRequest.forward(Combiner combiner,
PlaceholderMap layout)
Calls the
Combiner.aside(AsideRequest) method of combiner with the
successor of the current location . |
AsideAnswer |
DefaultAsideRequest.forward(Combiner combiner,
PlaceholderMap layout) |
Constructor and Description |
---|
DefaultAsideAnswer(boolean canceled,
DockableProperty location,
PlaceholderMap layout)
Creates a new answer.
|
DefaultAsideRequest.CombinerForward(Combiner combiner,
PlaceholderMap layout) |
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
PerspectiveStation.getPlaceholders()
Converts the contents of this station into a map of placeholders.
|
Modifier and Type | Method and Description |
---|---|
void |
PerspectiveStation.setPlaceholders(PlaceholderMap placeholders)
Informs this station of the content that it should show
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
FlapDockPerspective.getPlaceholders() |
PlaceholderMap |
FlapDockStationLayout.getPlaceholders()
Gets all the items.
|
PlaceholderMap |
FlapDockPerspective.toMap(Map<PerspectiveDockable,Integer> children) |
Modifier and Type | Method and Description |
---|---|
void |
FlapDockPerspective.read(PlaceholderMap map,
Map<Integer,PerspectiveDockable> children)
Updates the content of this perspective by reading the contents of
map . |
void |
FlapDockPerspective.setPlaceholders(PlaceholderMap placeholders) |
Constructor and Description |
---|
FlapDockStationLayout(boolean autoDirection,
FlapDockStation.Direction direction,
PlaceholderMap placeholders)
Creates a new layout
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
ScreenDockPerspective.getPlaceholders() |
PlaceholderMap |
ScreenDockStationLayout.getPlaceholders()
Gets all the items of this layout, including the encoded
Dockable s. |
PlaceholderMap |
ScreenDockPerspective.toMap(Map<PerspectiveDockable,Integer> children)
Converts the content of this perspective to a
PlaceholderMap that can be
stored persistently. |
Modifier and Type | Method and Description |
---|---|
void |
ScreenDockPerspective.read(PlaceholderMap map,
Map<Integer,PerspectiveDockable> children)
Reads the contents of
map and replaces any content of this perspective. |
void |
ScreenDockPerspective.setPlaceholders(PlaceholderMap placeholders) |
Constructor and Description |
---|
ScreenDockStationLayout(PlaceholderMap placeholders)
Creates a new layout.
|
Modifier and Type | Field and Description |
---|---|
PlaceholderMap |
AbstractSplitDockGrid.Node.placeholderMap
a map containing placeholder information for a
DockStation that could be placed
as this location. |
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
SplitDockPerspective.Entry.getPlaceholderMap()
Gets the placeholder information of a potential child
DockStation . |
PlaceholderMap |
SplitDockStationLayout.Entry.getPlaceholderMap()
Gets the placeholder information of a potential child
DockStation . |
PlaceholderMap |
SplitNode.getPlaceholderMap()
Gets placeholder information of a child
DockStation . |
protected abstract PlaceholderMap |
AbstractSplitPlaceholderConverter.getPlaceholderMap(N node)
Gets the
PlaceholderMap which is associated with node . |
protected PlaceholderMap |
SplitPerspectivePlaceholderConverter.getPlaceholderMap(SplitDockPerspective.Entry node) |
PlaceholderMap |
SplitDockTree.getPlaceholderMap(SplitDockTree.Key key)
Gets the placeholder information of the child
DockStation of key . |
protected PlaceholderMap |
SplitPlaceholderConverter.getPlaceholderMap(SplitNode node) |
PlaceholderMap |
AbstractSplitPlaceholderConverter.getPlaceholders()
Converts the station of this converter into a
PlaceholderMap . |
PlaceholderMap |
SplitDockCombinerSource.getPlaceholders() |
PlaceholderMap |
SplitDockPerspective.getPlaceholders() |
Modifier and Type | Method and Description |
---|---|
N |
SplitTreeFactory.horizontal(N left,
N right,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible)
Informs about a node that is divided vertically.
|
SplitDockPathProperty |
SplitTreePathFactory.horizontal(SplitDockPathProperty left,
SplitDockPathProperty right,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible) |
SplitDockTree.Key |
SplitDockTree.horizontal(SplitDockTree.Key left,
SplitDockTree.Key right,
double divider,
Path[] placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Adds two elements horizontally.
|
SplitDockTree.Key |
SplitDockTreeFactory.horizontal(SplitDockTree.Key left,
SplitDockTree.Key right,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible) |
SplitDockTree.Key |
SplitDockTreeFactory.leaf(Dockable dockable,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap) |
N |
SplitTreeFactory.leaf(Dockable dockable,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap)
Informs about a leaf of the tree.
|
SplitDockPathProperty |
SplitTreePathFactory.leaf(Dockable check,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap) |
SplitDockTree.Key |
SplitDockTreeFactory.placeholder(long id,
Path[] placeholders,
PlaceholderMap placeholderMap) |
N |
SplitTreeFactory.placeholder(long id,
Path[] placeholders,
PlaceholderMap placeholderMap)
Informs about a set of placeholder in the tree.
|
SplitDockPathProperty |
SplitTreePathFactory.placeholder(long id,
Path[] placeholders,
PlaceholderMap placeholderMap) |
SplitDockTree.Key |
SplitDockTree.put(D[] dockables,
D selected,
Path[] placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Creates a key for the set of
dockables or the set of
placeholders . |
SplitDockTree.Key |
SplitDockTree.put(Path[] placeholders,
PlaceholderMap placeholderMap)
Creates a key for a placeholder leaf.
|
SplitDockTree.Key |
SplitDockTree.put(Path[] placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Creates a key for a placeholder leaf.
|
void |
SplitPlaceholderSet.removeDoublePlaceholders(SplitNode node,
PlaceholderMap map)
Removes any placeholder from
placeholderMap that is stored in another node
than node . |
void |
AbstractSplitDockGrid.setPlaceholderMap(double x,
double y,
double width,
double height,
PlaceholderMap map)
Sets the
PlaceholderMap map for the items at the given location. |
void |
SplitDockPerspective.Entry.setPlaceholderMap(PlaceholderMap placeholderMap)
Sets all the placeholders that are associated with this entry.
|
void |
SplitNode.setPlaceholderMap(PlaceholderMap placeholderMap)
Sets information about the placeholders of a
DockStation that was
child of this node. |
void |
AbstractSplitPlaceholderConverter.setPlaceholders(PlaceholderMap map)
Reads
map and updates the contents of the SplitDockStation that is
related to this converter. |
void |
SplitDockPerspective.setPlaceholders(PlaceholderMap placeholders) |
N |
SplitTreeFactory.vertical(N top,
N bottom,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible)
Informs about a node that is divided vertically.
|
SplitDockPathProperty |
SplitTreePathFactory.vertical(SplitDockPathProperty top,
SplitDockPathProperty bottom,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible) |
SplitDockTree.Key |
SplitDockTree.vertical(SplitDockTree.Key top,
SplitDockTree.Key bottom,
double divider,
Path[] placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Adds two elements vertically.
|
SplitDockTree.Key |
SplitDockTreeFactory.vertical(SplitDockTree.Key top,
SplitDockTree.Key bottom,
double divider,
long id,
Path[] placeholders,
PlaceholderMap placeholderMap,
boolean visible) |
Constructor and Description |
---|
SplitDockPerspective.Entry(Set<Path> placeholders,
PlaceholderMap placeholderMap,
long id)
Create a new entry
|
SplitDockPerspective.Leaf(PerspectiveDockable dockable,
Set<Path> placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Creates a new leaf
|
SplitDockPerspective.Node(SplitDockStation.Orientation orientation,
double divider,
SplitDockPerspective.Entry childA,
SplitDockPerspective.Entry childB,
Set<Path> placeholders,
PlaceholderMap placeholderMap,
long id)
Creates a new node.
|
SplitDockStationLayout.Entry(Path[] placeholders,
PlaceholderMap placeholderMap,
long id)
Create a new entry
|
SplitDockStationLayout.Leaf(int id,
Path[] placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Creates a new leaf
|
SplitDockStationLayout.Node(SplitDockStation.Orientation orientation,
double divider,
SplitDockStationLayout.Entry childA,
SplitDockStationLayout.Entry childB,
Path[] placeholders,
PlaceholderMap placeholderMap,
long id)
Creates a new node.
|
SplitDockTree.Key(Path[] placeholders,
PlaceholderMap placeholderMap,
long id)
Creates a new key
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
StackDockPerspective.getPlaceholders() |
PlaceholderMap |
StackDockStationLayout.getPlaceholders()
Gets all the items of this layout, including the encoded
Dockable s. |
PlaceholderMap |
StackDockPerspective.toMap(Map<PerspectiveDockable,Integer> children)
Converts this perspective into a
PlaceholderMap . |
Modifier and Type | Method and Description |
---|---|
boolean |
StackDockPerspective.canRead(PlaceholderMap placeholders)
Tells whether
placeholders has the right format for this perspective to read it. |
void |
StackDockPerspective.read(PlaceholderMap placeholders,
Map<Integer,PerspectiveDockable> children,
int selected)
Reads the contents of
map and replaces any content of this perspective. |
void |
StackDockPerspective.setPlaceholders(PlaceholderMap placeholders) |
Constructor and Description |
---|
StackDockStationLayout(int selected,
PlaceholderMap placeholders)
Creates a new layout.
|
Modifier and Type | Method and Description |
---|---|
PlaceholderMap |
PlaceholderMap.copy()
Creates a deep copy of this map.
|
PlaceholderMap |
PlaceholderMap.filter(PlaceholderStrategy strategy)
May return this or a copy of this
PlaceholderMap to which strategy was applied. |
PlaceholderMap |
PlaceholderList.getMap(Path placeholder)
Gets the
PlaceholderMap that was used for a station at location placeholder . |
PlaceholderMap |
PlaceholderMap.getMap(PlaceholderMap.Key placeholder,
String key)
Gets the map that is stored under
key |
PlaceholderMap |
ConvertedPlaceholderListItem.getPlaceholderMap()
Gets additional information about this item.
|
PlaceholderMap |
PlaceholderList.Item.getPlaceholderMap()
Gets the placeholder information of a child
DockStation . |
PlaceholderMap |
CombinerSource.getPlaceholders()
Gets a map of placeholders which are to be used for creating the combined
Dockable . |
PlaceholderMap |
CombinerSourceWrapper.getPlaceholders() |
protected PlaceholderMap |
DockablePlaceholderList.getPlaceholders(DockStation station) |
protected PlaceholderMap |
PerspectivePlaceholderList.getPlaceholders(PerspectiveStation station) |
protected abstract PlaceholderMap |
PlaceholderList.getPlaceholders(S station)
Gets all the placeholders that are used by
station . |
PlaceholderMap |
DockablePlaceholderList.toMap()
Converts this list into a
PlaceholderMap , any remaining Dockable or
DockStation will be converted into its placeholder using the currently installed
PlaceholderStrategy . |
PlaceholderMap |
PerspectivePlaceholderList.toMap()
Converts this list into a
PlaceholderMap , any remaining Dockable or
DockStation will be converted into its placeholder using the currently installed
PlaceholderStrategy . |
PlaceholderMap |
PlaceholderList.toMap(PlaceholderListItemConverter<?,? super P> converter)
Converts this list into a
PlaceholderMap , any remaining Dockable or
DockStation will be converted using converter . |
Modifier and Type | Method and Description |
---|---|
void |
PlaceholderMap.putMap(PlaceholderMap.Key placeholder,
String key,
PlaceholderMap value)
Stores the value
value in this map, adds
placeholder if necessary, overrides the value stored at
key if existent. |
void |
PlaceholderList.read(PlaceholderMap map,
PlaceholderListItemConverter<D,P> converter)
Reads the contents of
map and adds them at the end of this list. |
protected void |
PlaceholderList.read(PlaceholderMap map,
PlaceholderListItemConverter<D,P> converter,
boolean simulate)
Reads the contents of
map . |
void |
ConvertedPlaceholderListItem.setPlaceholderMap(PlaceholderMap map)
Associates a map of data with this item.
|
void |
PlaceholderList.Item.setPlaceholderMap(PlaceholderMap placeholders)
Assuming this item represents a
Dockable that is a DockStation ,
sets the placeholder information of that DockStation . |
protected void |
DockablePlaceholderList.setPlaceholders(DockStation station,
PlaceholderMap map) |
protected void |
PerspectivePlaceholderList.setPlaceholders(PerspectiveStation station,
PlaceholderMap map) |
protected abstract void |
PlaceholderList.setPlaceholders(S station,
PlaceholderMap map)
Sets all the placeholders that should be used by
station . |
static <P extends PlaceholderListItem<Dockable>> |
DockablePlaceholderList.simulatedRead(PlaceholderMap map,
PlaceholderListItemConverter<Dockable,P> converter)
Simulates a call to
PlaceholderList.read(PlaceholderMap, PlaceholderListItemConverter) and makes all calls to converter
that would be made in a real read as well. |
static <P extends PlaceholderListItem<PerspectiveDockable>> |
PerspectivePlaceholderList.simulatedRead(PlaceholderMap map,
PlaceholderListItemConverter<PerspectiveDockable,P> converter)
Simulates a call to
PlaceholderList.read(PlaceholderMap, PlaceholderListItemConverter) and makes all calls to converter
that would be made in a real read as well. |
Constructor and Description |
---|
DockablePlaceholderList(PlaceholderMap map)
Creates a new list reading all the data that is stored in
map . |
DockablePlaceholderList(PlaceholderMap map,
PlaceholderListItemConverter<Dockable,P> converter)
Creates a new list reading all the data that is stored in
map . |
PerspectivePlaceholderList(PlaceholderMap map)
Creates a new list using
map to fill in the initial content. |
PerspectivePlaceholderList(PlaceholderMap map,
PlaceholderListItemConverter<PerspectiveDockable,P> converter)
Creates a new list reading all the data that is stored in
map . |
PlaceholderList.Item(P dockable,
Set<Path> placeholderSet,
PlaceholderMap placeholderMap)
Creates a new item.
|
PlaceholderList(PlaceholderMap map,
PlaceholderListItemConverter<D,P> converter)
Creates a new list reading all the data that is stored in
map . |