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
Dockable s
on their DockStation and allowing to store the
whole layout of a set of Dockable s and stations. |
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. |
bibliothek.gui.dock.util |
Distribution of information in a global scale and methods available from
everywhere.
|
Modifier and Type | Method and Description |
---|---|
P |
DockFactory.layoutPerspective(L layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children)
Creates an element that can be used by a
Perspective to create a layout
without creating any DockElement s. |
void |
DockFactory.layoutPerspective(P perspective,
L layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children)
Updates the contents of
perspective such that it reflects the contents of layout . |
Modifier and Type | Class and Description |
---|---|
class |
DefaultDockablePerspective
Implementation of a
PerspectiveElement that represents a DefaultDockable . |
Modifier and Type | Method and Description |
---|---|
PerspectiveDockable |
DefaultDockablePerspective.asDockable() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
DefaultDockableFactory.getPerspectiveLayout(DefaultDockablePerspective element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
void |
DefaultDockableFactory.layoutPerspective(DefaultDockablePerspective perspective,
java.lang.Object layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
DefaultDockablePerspective |
DefaultDockableFactory.layoutPerspective(java.lang.Object layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
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 |
---|---|
BackupFactoryData<L> |
RegisteringDockFactory.getPerspectiveLayout(P element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
P |
RegisteringDockFactory.layoutPerspective(BackupFactoryData<L> layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
void |
RegisteringDockFactory.layoutPerspective(P perspective,
BackupFactoryData<L> layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
Modifier and Type | Method and Description |
---|---|
L |
DockConverter.getPerspectiveLayout(P element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children)
Gets the layout information that is associated with
element . |
Modifier and Type | Method and Description |
---|---|
PerspectiveDockable |
PerspectiveElement.asDockable()
Returns the representation of
this as PerspectiveDockable . |
PerspectiveDockable |
PerspectiveStation.getDockable(int index)
Gets the index'th child of this station.
|
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.
|
boolean |
PerspectiveStation.remove(PerspectiveDockable dockable)
Removes a child of this station, can leave behind a placeholder.
|
void |
PerspectiveStation.replace(PerspectiveDockable oldDockable,
PerspectiveDockable newDockable)
Replaces
oldDockable by newDockable . |
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 Dockable s. |
Modifier and Type | Method and Description |
---|---|
PerspectiveDockable |
FlapDockPerspective.asDockable() |
PerspectiveDockable |
FlapDockPerspective.getDockable(int index) |
PerspectiveDockable |
FlapDockPerspective.remove(int index)
Removes the
index 'th element of this perspective. |
Modifier and Type | Method and Description |
---|---|
void |
FlapDockPerspective.add(PerspectiveDockable dockable)
Adds
dockable at the end of the list of children. |
void |
FlapDockPerspective.add(PerspectiveDockable dockable,
boolean hold,
int size)
Adds
dockable at the end of the list of children. |
void |
FlapDockPerspective.addPlaceholder(PerspectiveDockable dockable)
Adds a placeholder for
dockable and all its children to the end
of the list of dockables. |
DockableProperty |
FlapDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
int |
FlapDockPerspective.getSize(PerspectiveDockable dockable)
Gets the preferred size of the window that shows
dockable . |
int |
FlapDockPerspective.indexOf(PerspectiveDockable dockable)
Gets the current index of
dockable . |
void |
FlapDockPerspective.insert(int index,
PerspectiveDockable dockable)
Adds a
Dockable to this station. |
void |
FlapDockPerspective.insert(int index,
PerspectiveDockable dockable,
boolean hold,
int size)
Adds
dockable to this station. |
void |
FlapDockPerspective.insertPlaceholder(int index,
PerspectiveDockable dockable)
Adds a placeholder for
dockable and all its children at
location index to the list of dockables. |
boolean |
FlapDockPerspective.isHold(PerspectiveDockable dockable)
Tells whether
dockable should stay open even if it lost focus. |
boolean |
FlapDockPerspective.remove(PerspectiveDockable dockable) |
void |
FlapDockPerspective.replace(PerspectiveDockable oldDockable,
PerspectiveDockable newDockable) |
void |
FlapDockPerspective.setHold(PerspectiveDockable dockable,
boolean hold)
Sets whether
dockable should stay open even if it lost focus. |
void |
FlapDockPerspective.setSize(PerspectiveDockable dockable,
int size)
Sets the preferred size of the window that shows
dockable . |
Modifier and Type | Method and Description |
---|---|
FlapDockStationLayout |
FlapDockStationFactory.getPerspectiveLayout(FlapDockPerspective element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
void |
FlapDockStationFactory.layoutPerspective(FlapDockPerspective perspective,
FlapDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
FlapDockPerspective |
FlapDockStationFactory.layoutPerspective(FlapDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
void |
FlapDockPerspective.read(PlaceholderMap map,
java.util.Map<java.lang.Integer,PerspectiveDockable> children)
Updates the content of this perspective by reading the contents of
map . |
PlaceholderMap |
FlapDockPerspective.toMap(java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
Modifier and Type | Method and Description |
---|---|
PerspectiveDockable |
ScreenDockPerspective.asDockable() |
PerspectiveDockable |
ScreenDockPerspective.ScreenPerspectiveWindow.asDockable() |
PerspectiveDockable |
ScreenDockPerspective.getDockable(int index) |
PerspectiveDockable |
ScreenDockPerspective.remove(int index)
Removes the
index 'th element of this station. |
Modifier and Type | Method and Description |
---|---|
void |
ScreenDockPerspective.add(PerspectiveDockable dockable,
int x,
int y,
int width,
int height)
Adds
dockable at location x/y with size width/height to
this perspective. |
void |
ScreenDockPerspective.add(PerspectiveDockable dockable,
int x,
int y,
int width,
int height,
boolean fullscreen)
Adds
dockable at location x/y with size width/height to
this perspective. |
void |
ScreenDockPerspective.add(PerspectiveDockable dockable,
java.awt.Rectangle bounds)
Adds
dockable with boundaries bounds to this perspective. |
void |
ScreenDockPerspective.add(PerspectiveDockable dockable,
java.awt.Rectangle bounds,
boolean fullscreen)
Adds
dockable width boundaries bounds to this perspective |
void |
ScreenDockPerspective.addPlaceholder(PerspectiveDockable dockable,
int x,
int y,
int width,
int height)
Adds a placeholder for
dockable and all its children to this
station. |
void |
ScreenDockPerspective.addPlaceholder(PerspectiveDockable dockable,
java.awt.Rectangle bounds)
Adds a placeholder for
dockable and all its children to this
station. |
DockableProperty |
ScreenDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
ScreenDockPerspective.ScreenPerspectiveWindow |
ScreenDockPerspective.getWindow(PerspectiveDockable dockable)
Gets access to the window that shows
dockable |
int |
ScreenDockPerspective.indexOf(PerspectiveDockable dockable)
Gets the index of
dockable . |
boolean |
ScreenDockPerspective.remove(PerspectiveDockable dockable)
Removes the child
dockable from this station. |
void |
ScreenDockPerspective.replace(PerspectiveDockable oldDockable,
PerspectiveDockable newDockable) |
Modifier and Type | Method and Description |
---|---|
ScreenDockStationLayout |
ScreenDockStationFactory.getPerspectiveLayout(ScreenDockPerspective element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
void |
ScreenDockStationFactory.layoutPerspective(ScreenDockPerspective perspective,
ScreenDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
ScreenDockPerspective |
ScreenDockStationFactory.layoutPerspective(ScreenDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
void |
ScreenDockPerspective.read(PlaceholderMap map,
java.util.Map<java.lang.Integer,PerspectiveDockable> children)
Reads the contents of
map and replaces any content of this perspective. |
PlaceholderMap |
ScreenDockPerspective.toMap(java.util.Map<PerspectiveDockable,java.lang.Integer> children)
Converts the content of this perspective to a
PlaceholderMap that can be
stored persistently. |
Constructor and Description |
---|
ScreenPerspectiveWindow(PerspectiveDockable dockable)
Creates a new object.
|
Modifier and Type | Class and Description |
---|---|
class |
SplitDockPerspective
Represents a
SplitDockStation in a Perspective . |
Modifier and Type | Method and Description |
---|---|
protected PerspectiveDockable[] |
PerspectiveSplitDockGrid.array(int size) |
PerspectiveDockable[] |
PerspectiveSplitDockTree.array(int size) |
PerspectiveDockable |
SplitDockPerspective.asDockable() |
protected PerspectiveDockable |
SplitDockPerspective.combine(PerspectiveDockable[] dockables,
PerspectiveDockable selection)
Combines several
dockables to one dockable. |
PerspectiveDockable |
SplitDockPerspective.Leaf.getDockable()
Gets the element which is represented by this leaf.
|
PerspectiveDockable |
SplitDockPerspective.getDockable(int index) |
protected PerspectiveDockable |
SplitPerspectivePlaceholderConverter.getDockable(SplitDockPerspective.Entry leaf) |
PerspectiveDockable |
SplitDockPerspective.getFullscreen()
Gets the element which is in fullscreen-mode
|
protected PerspectiveDockable[] |
PerspectiveSplitDockGrid.unpack(PerspectiveDockable dockable) |
Modifier and Type | Method and Description |
---|---|
protected SplitDockTree<PerspectiveDockable> |
SplitPerspectivePlaceholderConverter.createTree() |
Modifier and Type | Method and Description |
---|---|
protected PerspectiveDockable |
SplitDockPerspective.combine(PerspectiveDockable[] dockables,
PerspectiveDockable selection)
Combines several
dockables to one dockable. |
protected PerspectiveDockable |
SplitDockPerspective.combine(PerspectiveDockable[] dockables,
PerspectiveDockable selection)
Combines several
dockables to one dockable. |
SplitDockPathProperty |
SplitDockPerspective.getDockablePathProperty(PerspectiveDockable child)
Creates the location information for
child that directly describes the path through the
tree to the element. |
DockableProperty |
SplitDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
SplitDockPerspective.Leaf |
SplitDockPerspective.getLeaf(PerspectiveDockable child)
Searches and returns the leaf that shows
child . |
protected Path |
SplitPerspectivePlaceholderConverter.getPlaceholderFor(PerspectiveDockable dockable) |
void |
SplitDockPerspective.EntryListener.modified(SplitDockPerspective.Leaf leaf,
PerspectiveDockable oldDockable,
PerspectiveDockable newDockable)
Called if the content of
leaf has been modified. |
void |
SplitDockPerspective.read(PerspectiveSplitDockTree tree,
PerspectiveDockable fullscreen)
Reads the contents of
tree and replaces any content of this perspective |
boolean |
SplitDockPerspective.remove(PerspectiveDockable dockable) |
void |
SplitDockPerspective.replace(PerspectiveDockable oldDockable,
PerspectiveDockable newDockable) |
void |
SplitDockPerspective.Leaf.setDockable(PerspectiveDockable dockable)
Exchanges the element that is represented by this perspective.
|
void |
SplitDockPerspective.setFullscreen(PerspectiveDockable fullscreen)
Sets the element which is in fullscreen-mode, must be a child of this perspective
|
protected PerspectiveDockable[] |
PerspectiveSplitDockGrid.unpack(PerspectiveDockable dockable) |
Modifier and Type | Method and Description |
---|---|
protected void |
SplitPerspectivePlaceholderConverter.dropTree(SplitDockPerspective station,
SplitDockTree<PerspectiveDockable> tree) |
SplitDockStationLayout |
SplitDockStationFactory.getPerspectiveLayout(SplitDockPerspective element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
void |
SplitDockStationFactory.layoutPerspective(SplitDockPerspective perspective,
SplitDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
SplitDockPerspective |
SplitDockStationFactory.layoutPerspective(SplitDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
Constructor and Description |
---|
Leaf(PerspectiveDockable dockable,
java.util.Set<Path> placeholders,
PlaceholderMap placeholderMap,
long nodeId)
Creates a new leaf
|
Modifier and Type | Class and Description |
---|---|
class |
StackDockPerspective
A representation of a
StackDockStation in a Perspective . |
Modifier and Type | Method and Description |
---|---|
PerspectiveDockable |
StackDockPerspective.asDockable() |
PerspectiveDockable |
StackDockPerspective.getDockable(int index) |
PerspectiveDockable |
StackDockPerspective.getSelection()
Gets the currently selected element.
|
PerspectiveDockable |
StackDockPerspective.remove(int index)
Removes the
index 'th child of this station. |
Modifier and Type | Method and Description |
---|---|
void |
StackDockPerspective.add(PerspectiveDockable dockable)
Adds
dockable at the end of the list of dockables. |
void |
StackDockPerspective.addPlaceholder(PerspectiveDockable dockable)
Adds a placeholder for
dockable at the end of the list of dockables. |
DockableProperty |
StackDockPerspective.getDockableProperty(PerspectiveDockable child,
PerspectiveDockable target) |
int |
StackDockPerspective.indexOf(PerspectiveDockable dockable)
Gets the location of
dockable . |
void |
StackDockPerspective.insert(int index,
PerspectiveDockable dockable)
Inserts
dockable at location index . |
void |
StackDockPerspective.insertPlaceholder(int index,
PerspectiveDockable dockable)
Adds a placeholder for
dockable at location index . |
boolean |
StackDockPerspective.remove(PerspectiveDockable dockable)
Removes
dockable from this station. |
void |
StackDockPerspective.replace(PerspectiveDockable oldDockable,
PerspectiveDockable newDockable) |
void |
StackDockPerspective.setSelection(PerspectiveDockable dockable)
Changes the selected element of this station.
|
Modifier and Type | Method and Description |
---|---|
StackDockStationLayout |
StackDockStationFactory.getPerspectiveLayout(StackDockPerspective element,
java.util.Map<PerspectiveDockable,java.lang.Integer> children) |
void |
StackDockStationFactory.layoutPerspective(StackDockPerspective perspective,
StackDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
StackDockPerspective |
StackDockStationFactory.layoutPerspective(StackDockStationLayout layout,
java.util.Map<java.lang.Integer,PerspectiveDockable> children) |
void |
StackDockPerspective.read(PlaceholderMap placeholders,
java.util.Map<java.lang.Integer,PerspectiveDockable> children,
int selected)
Reads the contents of
map and replaces any content of this perspective. |
PlaceholderMap |
StackDockPerspective.toMap(java.util.Map<PerspectiveDockable,java.lang.Integer> children)
Converts this perspective into a
PlaceholderMap . |
Constructor and Description |
---|
StackDockPerspective(PerspectiveDockable[] children,
PerspectiveDockable selection)
Creates a new perspective.
|
StackDockPerspective(PerspectiveDockable[] children,
PerspectiveDockable selection)
Creates a new perspective.
|
Modifier and Type | Class and Description |
---|---|
class |
PerspectivePlaceholderList<P extends PlaceholderListItem<PerspectiveDockable>>
A
PlaceholderList that works only with PerspectiveElement s.The PlaceholderStrategy of this list is automatically set during construction
and there is no need for clients to call PlaceholderList.bind() or PlaceholderList.unbind() . |
class |
PerspectivePlaceholderListItemConverter<D extends PlaceholderListItem<PerspectiveDockable>> |
Modifier and Type | Method and Description |
---|---|
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. |
Modifier and Type | Method and Description |
---|---|
protected PerspectiveDockable[] |
PerspectivePlaceholderList.getChildren(PerspectiveStation station) |
Modifier and Type | Method and Description |
---|---|
protected Path |
PerspectivePlaceholderList.getPlaceholder(PerspectiveDockable dockable) |
protected PerspectiveStation |
PerspectivePlaceholderList.toStation(PerspectiveDockable dockable) |
protected java.lang.String |
PerspectivePlaceholderList.toString(PerspectiveDockable dockable) |
Modifier and Type | Method and Description |
---|---|
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 |
---|
PerspectivePlaceholderList(PlaceholderMap map,
PlaceholderListItemConverter<PerspectiveDockable,P> converter)
Creates a new list reading all the data that is stored in
map . |
Modifier and Type | Method and Description |
---|---|
static void |
DockUtilities.ensureTreeValidity(PerspectiveStation newParent,
PerspectiveDockable newChild)
Ensures that
newChild has either no parent or newParent as parent, and that there will
be no cycle when newChild is added to newParent |
static DockableProperty |
DockUtilities.getPropertyChain(PerspectiveStation ground,
PerspectiveDockable dockable)
|