Package | Description |
---|---|
bibliothek.extension.gui.dock.theme.bubble |
Various graphical and logical components used when
BubbleTheme is
active. |
bibliothek.extension.gui.dock.theme.eclipse.stack |
An implementation of
TabPane and
supporting classes for the EclipseTheme . |
bibliothek.extension.gui.dock.theme.eclipse.stack.tab |
Various components needed to paint and manage the tab which is visible
on a
EclipseTabPane . |
bibliothek.extension.gui.dock.theme.flat |
Various graphical and logical components needed to paint the layout
when
FlatTheme is active. |
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.disable |
Contains the
DisablingStrategy and associated classes,
allows clients to disable Dockable s, DockTitle s
or DockAction s. |
bibliothek.gui.dock.dockable |
Some classes related to
Dockable . |
bibliothek.gui.dock.event |
Listeners, adapters and events used in the whole framework.
A Listener is added to some object that needs to be observed, the Listener will be informed whenever the observed object changes. An Adapter is an implementation of a Listener, but the methods of an Adapter are empty. An Event is an object carrying information from an observed object to a Listener. |
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.station |
Elements needed by various implementations of the
DockStation interface. |
bibliothek.gui.dock.station.stack |
Elements which are related to the
StackDockStation . |
bibliothek.gui.dock.title |
Elements needed to paint the title of a
Dockable . |
bibliothek.gui.dock.util |
Distribution of information in a global scale and methods available from
everywhere.
|
Modifier and Type | Method and Description |
---|---|
DockElement |
BubbleTab.getElement() |
Modifier and Type | Method and Description |
---|---|
DockElement |
EclipseTab.getElement() |
Modifier and Type | Method and Description |
---|---|
DockElement |
BaseTabComponent.getElement() |
DockElement |
DockTitleTab.getElement()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
DockElement |
FlatTab.getElement() |
Modifier and Type | Interface and Description |
---|---|
interface |
Dockable
A
Dockable is a window which can be dragged around by the user. |
interface |
DockStation
A
DockStation is some area (e.g. |
Modifier and Type | Method and Description |
---|---|
DockElementRepresentative[] |
DockController.getRepresentatives(DockElement element)
Searches all registered
DockElementRepresentative whose element is element . |
boolean |
DockFrontend.isHiddenRootStation(DockElement element)
Tells whether
element is a root-station and at the same time a Dockable
without parent. |
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 |
DefaultDockable
|
class |
FlapDockStation
This
DockStation shows only a title for each of it's children.If the user clicks on one of the titles, a window will popup. |
class |
ScreenDockStation
A
DockStation which is the whole screen. |
class |
SplitDockStation
This station shows all its children at once.
|
class |
StackDockStation
On this station, only one of many children is visible.
|
Modifier and Type | Method and Description |
---|---|
DockElement |
DockElementRepresentative.getElement()
Gets the element which is represented by
this . |
DockElement |
SplitDockStation.getElement() |
Modifier and Type | Method and Description |
---|---|
void |
DisablingStrategyListener.changed(DockElement item)
Called if the disabled state either of
item , or of one or many of its sub-items changed. |
boolean |
DisablingStrategy.isDisabled(DockElement item)
Tells whether the item
DockElement is disabled in general. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractDockable
An implementation of
Dockable which deals with the simple things.Some of the capabilities of an AbstractDockable are: add or remove a DockableListener , and fire an event
set the parent and the controller
set the title and the icon
store a list of DockActions
|
Modifier and Type | Method and Description |
---|---|
DockElement |
AbstractDockable.getElement() |
Modifier and Type | Method and Description |
---|---|
DockElement |
LocatedListener.getTreeLocation()
Gets the location of this observer in the tree.
|
Modifier and Type | Method and Description |
---|---|
List<L> |
LocatedListenerList.affected(DockElement element)
Creates a list of all
LocatedListener s which are affected
by an event which occurs on element . |
boolean |
KeyboardListener.keyPressed(DockElement element,
KeyEvent event)
Called when a key has been pressed.
|
boolean |
KeyboardListener.keyReleased(DockElement element,
KeyEvent event)
Called when a key has been released.
|
boolean |
KeyboardListener.keyTyped(DockElement element,
KeyEvent event)
Called when a key has been types.
|
Modifier and Type | Method and Description |
---|---|
PerspectiveElement |
DefaultFrontendPerspectiveCache.get(String id,
DockElement element,
boolean isRootStation) |
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 |
FrontendPerspectiveCacheExtension.get(String id,
DockElement element,
boolean isRootStation)
Converts
element into a PerspectiveElement . |
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 |
---|---|
<D extends DockElement> |
PredefinedDockSituation.listVisible(Collection<D> base,
DockLayoutComposition composition)
Given a set of
Dockable s this method
estimates which of them will be visible once composition
is applied. |
Modifier and Type | Method and Description |
---|---|
DockElement |
DockSituation.convert(DockLayoutComposition composition)
Reads the contents of
composition and tries to create a
DockElement that matches the composition. |
Modifier and Type | Method and Description |
---|---|
protected DockFactory<? extends DockElement,?,BackupFactoryData<?>> |
PredefinedDockSituation.getBackup(String id)
Searches a backup factory with the name
id . |
DockFactory<? extends DockElement,?,?> |
DockSituation.getFactory(String id)
Gets the factory which has the given
id . |
DockFactory<? extends DockElement,?,?> |
PredefinedDockSituation.getFactory(String id) |
Modifier and Type | Method and Description |
---|---|
DockLayoutComposition |
DockSituation.convert(DockElement element)
Converts the layout of
element and all its children into a
DockLayoutComposition . |
protected String |
DockSituation.getID(DockElement element)
Gets the id of the factory which is needed to write (and later
read)
element |
String |
PredefinedDockSituation.getID(DockElement dockable) |
protected Path |
DockSituation.getPlaceholder(DockElement element)
Gets a placeholder for
element using the current PlaceholderStrategy . |
protected boolean |
DockSituation.ignoreElement(DockElement element)
Tells whether to ignore this element when saving.
|
boolean |
DockSituationIgnore.ignoreElement(DockElement element)
Tells whether to ignore this element when saving.
|
boolean |
AdjacentDockFactory.interested(DockElement element)
Tells whether this factory is interested in storing information for
element . |
void |
PredefinedDockSituation.put(DockElement element)
Deprecated.
use
PredefinedDockSituation.put(String, DockElement) instead |
void |
PredefinedDockSituation.put(String key,
DockElement element)
Registers an element at this situation.
|
protected boolean |
PredefinedDockSituation.shouldLayout(DockElement element)
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 | Method and Description |
---|---|
void |
PredefinedDockSituation.addBackup(DockFactory<? extends DockElement,?,? extends BackupFactoryData<?>> factory)
Adds a backup factory to this situation.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractDockableStation
An abstract combination between
DockStation and Dockable . |
class |
AbstractDockStation
An abstract implementation of
DockStation . |
Modifier and Type | Method and Description |
---|---|
DockElementRepresentative |
CombinedStackDockComponent.createDefaultRepresentation(DockElement target) |
DockElementRepresentative |
DefaultStackDockComponent.createDefaultRepresentation(DockElement target) |
DockElementRepresentative |
StackDockComponent.createDefaultRepresentation(DockElement target)
Creates and returns a new
DockElementRepresentative representing target ,
the new representation is to be used to cover all the empty areas on this StackDockComponent . |
void |
StackDockComponentRepresentative.setTarget(DockElement target)
Sets the target to which new
DockElementRepresentative s point. |
Modifier and Type | Method and Description |
---|---|
DockElement |
AbstractMultiDockTitle.getElement() |
Modifier and Type | Method and Description |
---|---|
DockElement |
SimpleDockElementRepresentative.getElement() |
Modifier and Type | Method and Description |
---|---|
static DockStation |
DockUtilities.getRoot(DockElement element)
Searches the station which is an ancestor of
element
and has no parent. |
static boolean |
DockUtilities.isAncestor(DockElement ancestor,
DockElement child)
Tells whether
child is identical with ancestor
or a child of ancestor . |
static List<Dockable> |
DockUtilities.listDockables(DockElement root,
boolean includeRoot)
Lists all
Dockable s in the tree under root . |
static void |
DockUtilities.visit(DockElement element,
DockUtilities.DockVisitor visitor)
Visits
element and all its children. |
Constructor and Description |
---|
SimpleDockElementRepresentative(DockElement element,
Component component)
Creates a new
SimpleDockElementRepresentative . |