Package | Description |
---|---|
bibliothek.extension.gui.dock.theme.bubble |
Various graphical and logical components used when
BubbleTheme is
active. |
bibliothek.extension.gui.dock.theme.eclipse |
Various graphical and logical components needed when the
EclipseTheme
is active. |
bibliothek.gui |
The high level interfaces of the framework and the most often used classes.
|
bibliothek.gui.dock.action |
The components dealing with the logic of
DockAction s. |
bibliothek.gui.dock.action.actions |
Contains a set of different
DockAction s
and supporting classes.The actions in this package will create views, which show Icon s,
text, tooltips and other gimmicks. |
bibliothek.gui.dock.action.view |
Classes to create a views for
DockAction s.This package does not contain any views, only the mechanism to create some. |
bibliothek.gui.dock.disable |
Contains the
DisablingStrategy and associated classes,
allows clients to disable Dockable s, DockTitle s
or DockAction s. |
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.station.flap |
Elements that are related to the
FlapDockStation . |
bibliothek.gui.dock.station.flap.button |
Contains the
ButtonContentFilter , which
allows clients to decide which DockAction s to show
on a 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.action |
Contains the
DockActionDistributor interface
which allows clients to tell where a DockAction appears, either
as part of a tab, of the info panel, or on the DockTitle .Clients can make use of the annotations InfoDockAction ,
TabDockAction and TitleDockAction
to easily mark the location of their actions. |
bibliothek.gui.dock.themes.basic.action |
Elements handling the view of
DockAction s.They way from a DockAction to its view normally involves four objects:
The DockAction itself, providing the basic set of properties
A handler listening to changes of the
action and forwarding the changes to the model. |
bibliothek.gui.dock.themes.basic.action.buttons |
Classes which allow to paint and interact with a
BasicButtonModel . |
bibliothek.gui.dock.themes.basic.action.dropdown |
Handlers taking various kinds of
DockAction and presenting them
as DropDownViewItem
in order to display them as children of a
DropDownAction |
bibliothek.gui.dock.themes.basic.action.menu |
Handlers taking various kinds of
DockAction and presenting them
as MenuViewItem in
order to display the actions in a menu. |
bibliothek.gui.dock.themes.color |
The color subsystem allows each kind of element to get its colors
from a central repository.
|
bibliothek.gui.dock.themes.font |
Implementations of
DockFont to be used
at different places (as described in the documentation for each item). |
bibliothek.gui.dock.title |
Elements needed to paint the title of a
Dockable . |
Modifier and Type | Method and Description |
---|---|
DockAction |
BubbleSeparator.getAction() |
Modifier and Type | Method and Description |
---|---|
protected AbstractDockColor |
RoundButton.createColor(java.lang.String key,
Dockable dockable,
DockAction action,
java.awt.Color backup)
Creates a new
DockColor representing one color used by this button. |
protected AbstractDockColor[] |
RoundButton.createColors(Dockable dockable,
DockAction action) |
Constructor and Description |
---|
RoundButton(BasicTrigger trigger,
BasicResourceInitializer initializer,
Dockable dockable,
DockAction action)
Creates a new round button.
|
RoundDropDownButton(BasicDropDownButtonHandler handler,
Dockable dockable,
DockAction action)
Creates a new button
|
Modifier and Type | Method and Description |
---|---|
protected EclipseTabDockActionLocation |
DefaultEclipseThemeConnector.getLocation(DockAction action,
EclipseTabStateInfo tab)
Gets the location of
action . |
protected boolean |
EclipseDockActionSource.include(DockAction action) |
boolean |
DefaultEclipseThemeConnector.shouldShowOnSide(DockAction action,
EclipseTabStateInfo tab) |
boolean |
EclipseThemeConnector.shouldShowOnSide(DockAction action,
EclipseTabStateInfo tab)
Tells whether
action should be shown on the right side of the
tab of dockable .Note that EclipseThemeConnector.shouldShowOnSide(DockAction, EclipseTabStateInfo) and EclipseThemeConnector.shouldShowOnTab(DockAction, EclipseTabStateInfo)
are independent of each other. |
boolean |
DefaultEclipseThemeConnector.shouldShowOnTab(DockAction action,
EclipseTabStateInfo tab) |
boolean |
EclipseThemeConnector.shouldShowOnTab(DockAction action,
EclipseTabStateInfo tab)
Tells whether
action should be shown on the tab of dockable .Note that EclipseThemeConnector.shouldShowOnSide(DockAction, EclipseTabStateInfo) and EclipseThemeConnector.shouldShowOnTab(DockAction, EclipseTabStateInfo)
are independent of each other. |
Modifier and Type | Class and Description |
---|---|
class |
DockFrontend.Hider
An object which is action and
ActionGuard at the same time. |
Modifier and Type | Class and Description |
---|---|
class |
ActionType<D extends DockAction>
The ActionType manly defines, how a
DockAction is to be used. |
Modifier and Type | Interface and Description |
---|---|
interface |
ButtonDockAction
An action that can be pressed like a button.
|
interface |
DropDownAction
A DockAction that consists of other actions.
|
interface |
ListeningDockAction
An action that should receive an event when the
DockController of
the structure using this action changes. |
interface |
MenuDockAction
Represents a menu.
|
interface |
SelectableDockAction
An action which has two states "selected" and "not selected".
|
interface |
StandardDockAction
A StandardDockAction is an object that is shown as graphical interface (like a button)
on some Components.
|
interface |
StandardDropDownItemAction
A combination of a
DropDownItemAction and a StandardDockAction . |
Modifier and Type | Class and Description |
---|---|
protected class |
StationChildrenActionSource.FocusAction
An action that can transfer the focus
|
Modifier and Type | Method and Description |
---|---|
protected DockAction |
StationChildrenActionSource.createActionFor(Dockable dockable)
Creates the
DockAction which is shown for dockable . |
DockAction |
ActionDockBorder.getAction()
Gets the action which is represented by this border.
|
DockAction |
DockActionBackgroundComponent.getAction()
Gets the
DockAction which is painted by this component. |
DockAction |
DockActionIcon.getAction()
Gets the action which is using the icon.
|
DockAction |
DockActionText.getAction()
Gets the action which is using the icon.
|
DockAction |
DefaultDockActionSource.getDockAction(int index) |
DockAction |
DockActionSource.getDockAction(int index)
Gets the index'th
DockAction of this source. |
DockAction |
FilteredDockActionSource.getDockAction(int index) |
DockAction |
HierarchyDockActionSource.getDockAction(int index) |
DockAction |
MultiDockActionSource.getDockAction(int index) |
DockAction |
StationChildrenActionSource.getDockAction(int index) |
DockAction |
DropDownAction.getSelection(Dockable dockable)
Gets the last selected action, which may be
null . |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<DockAction> |
DefaultDockActionSource.iterator() |
java.util.Iterator<DockAction> |
FilteredDockActionSource.iterator() |
java.util.Iterator<DockAction> |
HierarchyDockActionSource.iterator() |
java.util.Iterator<DockAction> |
MultiDockActionSource.iterator() |
java.util.Iterator<DockAction> |
StationChildrenActionSource.iterator() |
Modifier and Type | Method and Description |
---|---|
void |
DefaultDockActionSource.add(DockAction... action)
Adds all given actions to the end of this source.
|
void |
MultiDockActionSource.add(DockAction... actions)
Adds several actions to this source.
|
void |
DefaultDockActionSource.add(int index,
DockAction... actions)
Inserts all given actions such that the first action
will have the given
index , the second action
index+1 , and so on... |
protected void |
AbstractButtonContentFilter.fire(Dockable dockable,
DockAction action)
Calls
ButtonContentFilterListener.showTextChanged(ButtonContentFilter, Dockable, DockAction) on all
listeners that are currently registered |
protected int |
MultiDockActionSource.getSource(DockAction action)
Gets the index of the child-source which contains
action . |
protected abstract boolean |
FilteredDockActionSource.include(DockAction action)
Tells whether
action should be included in the list of
actions of this source, or not. |
int |
AbstractDockActionSource.indexOf(DockAction action)
Gets the index of the given
action |
int |
DefaultDockActionSource.indexOf(DockAction action) |
void |
AbstractButtonContentFilter.install(Dockable dockable,
DockAction action) |
void |
ButtonContentFilter.install(Dockable dockable,
DockAction action)
Informs this filter that
action which is connected to dockable will
be shown. |
protected void |
AbstractButtonContentFilter.installed(DockAction action)
Called the first time
action is installed. |
protected void |
AbstractButtonContentFilter.installed(DockAction action,
Dockable dockable)
Called the first time
dockable and action are installed. |
void |
DefaultDockActionSource.remove(DockAction action)
Removes the given
action from this source. |
void |
DropDownAction.setSelection(Dockable dockable,
DockAction selection)
Sets the current selection.
|
boolean |
ButtonContentFilter.showText(Dockable dockable,
DockAction action)
Tells whether the text of
action , that is associated with dockable , is to be shown. |
void |
ButtonContentFilterListener.showTextChanged(ButtonContentFilter filter,
Dockable dockable,
DockAction action)
Informs this listener that the result of
ButtonContentFilter.showText(Dockable, DockAction)
changed. |
void |
AbstractButtonContentFilter.uninstall(Dockable dockable,
DockAction action) |
void |
ButtonContentFilter.uninstall(Dockable dockable,
DockAction action)
Informs this filter that
action will no longer be shown. |
protected void |
AbstractButtonContentFilter.uninstalled(DockAction action)
Called after
action was uninstalled the last time. |
protected void |
AbstractButtonContentFilter.uninstalled(DockAction action,
Dockable dockable)
Called after
dockable and action have been uninstalled the last time. |
Constructor and Description |
---|
DefaultDockActionSource(DockAction... actions)
Default constructor, fills the list with some initial actions.
|
DefaultDockActionSource(LocationHint hint,
DockAction... actions)
Default constructor, fills the list with some initial actions.
|
DockActionIcon(java.lang.String id,
DockAction action)
Creates a new
DockActionIcon . |
DockActionIcon(java.lang.String id,
DockAction action,
Path kind)
Creates a new
DockActionIcon . |
DockActionText(java.lang.String id,
DockAction action)
Creates a new
DockActionText . |
DockActionText(java.lang.String id,
DockAction action,
Path kind)
Creates a new
DockActionText . |
Modifier and Type | Interface and Description |
---|---|
interface |
SharingDropDownDockAction
A
SharingDropDownDockAction is a DropDownAction whose properties are shared by
all Dockable s and whose properties can be set by the client. |
interface |
SharingDropDownItemAction
A
DropDownItemAction whose properties are shared among all Dockable s, the
properties can be modified by the client. |
interface |
SharingSelectableDockAction
A
SelectableDockAction whose properties are shared among all Dockable s, clients
can modify the properties. |
interface |
SharingStandardDockAction
A
SharingStandardDockAction is a StandardDockAction whose properties are
shared by all Dockable s and whose properties can be modified by the client. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractSimpleDropDownAction
A dropdown action based on one
DockActionSource which has to be specified
by a subclass. |
class |
AbstractStandardDockAction
An abstract implementation of the
DockAction -interface. |
class |
GroupedButtonDockAction<K>
A
GroupedDockAction that provides the functionality of
a ButtonDockAction . |
class |
GroupedDockAction<K,D extends SimpleDockAction>
A
DockAction which classifies its Dockables
in groups. |
class |
GroupedDropDownItemAction<K,D extends SimpleDropDownItemAction>
An action that can be shown as child of a
DropDownAction . |
class |
GroupedSelectableDockAction<K>
An action that can change between selected and not selected.
|
static class |
GroupedSelectableDockAction.Check<K>
An action intended to use as type
ActionType.CHECK |
static class |
GroupedSelectableDockAction.Radio<K>
An action intended to use as type
ActionType.RADIO |
class |
SeparatorAction
A separator represents a space between actions.
|
class |
SimpleButtonAction
A
ButtonDockAction that has the same properties for all
Dockables which use the action. |
class |
SimpleDockAction
A simple implementation of
DockAction . |
class |
SimpleDropDownAction
A dropdown action that has the same properties for all Dockables.
|
class |
SimpleDropDownItemAction
An action that can be shown as child of a
DropDownAction and
which has advanced information for the DropDownAction . |
class |
SimpleMenuAction
An action that provides a menu which contains other actions.
|
class |
SimpleSelectableAction
A
DockAction that has a state selected . |
static class |
SimpleSelectableAction.Check
A
SimpleSelectableAction that is visualized as
a ActionType.CHECK . |
static class |
SimpleSelectableAction.Radio
A
SimpleSelectableAction that is visualized as
a ActionType.RADIO . |
Modifier and Type | Method and Description |
---|---|
DockAction |
SimpleDropDownAction.getDockAction(int index)
Gets the
index 'th action of this menu. |
DockAction |
AbstractSimpleDropDownAction.getSelection()
Returns the currently selected action.
|
DockAction |
AbstractSimpleDropDownAction.getSelection(Dockable dockable) |
Modifier and Type | Method and Description |
---|---|
void |
SharingDropDownDockAction.add(DockAction action)
Adds an action to the menu.
|
void |
SimpleDropDownAction.add(DockAction action) |
void |
SharingDropDownDockAction.insert(int index,
DockAction... action)
Inserts a list of actions into the menu.
|
void |
SimpleDropDownAction.insert(int index,
DockAction... action) |
void |
SharingDropDownDockAction.insert(int index,
DockAction action)
Inserts an action into the menu.
|
void |
SimpleDropDownAction.insert(int index,
DockAction action) |
void |
SharingDropDownDockAction.remove(DockAction action)
Removes
action from the menu. |
void |
SimpleDropDownAction.remove(DockAction action) |
void |
AbstractSimpleDropDownAction.setSelection(Dockable dockable,
DockAction selection) |
void |
AbstractSimpleDropDownAction.setSelection(DockAction selection)
Changes the selection of this drop-down-action.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ViewGenerator<D extends DockAction,A>
A single entry for a
ActionViewConverter . |
Modifier and Type | Method and Description |
---|---|
<A,D extends DockAction> |
ActionViewConverter.createView(ActionType<D> type,
D action,
ViewTarget<A> target,
Dockable dockable)
Creates and sets up a new view.
|
protected <A,D extends DockAction> |
ActionViewConverter.getConverter(ActionType<D> action,
ViewTarget<? super A> target)
Searches a converter for the given
action and target . |
<A,D extends DockAction> |
ActionViewConverter.putClient(ActionType<D> action,
ViewTarget<A> target,
ViewGenerator<D,A> generator)
Registers a new
ViewGenerator to this ActionViewConverter. |
<A,D extends DockAction> |
ActionViewConverter.putDefault(ActionType<D> action,
ViewTarget<A> target,
ViewGenerator<D,A> generator)
Registers a new
ViewGenerator to this ActionViewConverter. |
<A,D extends DockAction> |
ActionViewConverter.putTheme(ActionType<D> action,
ViewTarget<A> target,
ViewGenerator<D,A> generator)
Registers a new
ViewGenerator to this ActionViewConverter. |
Modifier and Type | Method and Description |
---|---|
DockAction |
ConnectingViewItem.getAction() |
DockAction |
ViewItem.getAction()
Gets the action that is represented by this target.
|
Modifier and Type | Method and Description |
---|---|
<A> A |
ActionViewConverter.createView(DockAction action,
ViewTarget<A> target,
Dockable dockable)
Creates and sets up a new view.
|
Modifier and Type | Method and Description |
---|---|
boolean |
DisablingStrategy.isDisabled(Dockable dockable,
DockAction item)
Tells whether the action
item , which is shown together with dockable , is disabled. |
Constructor and Description |
---|
ActionDisablingStrategyObserver(DockAction action)
Creates a new observer.
|
Modifier and Type | Method and Description |
---|---|
void |
DropDownActionListener.selectionChanged(DropDownAction action,
java.util.Set<Dockable> dockables,
DockAction selection)
Called when the selection of
action has changed. |
Modifier and Type | Class and Description |
---|---|
class |
FlapDockDirection
This
DockAction is used as an action of a FlapDockStation . |
class |
FlapDockHoldToggle
This
DockAction is shown together with the children of a
FlapDockStation , and allows to "stick" a Dockable . |
Modifier and Type | Method and Description |
---|---|
void |
FlapDockStationSource.setHoldAction(DockAction holdAction)
Changes the action that is shown in this source
|
Constructor and Description |
---|
FlapDockStationSource(FlapDockStation station,
Dockable dockable,
DockAction holdAction)
Creates a new
FlapDockStationSource . |
Modifier and Type | Method and Description |
---|---|
boolean |
ButtonContentFilter.isButtonAction(DockAction action)
Tells whether
action is an important DockAction and should if the client told the
component to filter actions. |
boolean |
DefaultButtonContentFilter.isButtonAction(DockAction action) |
Modifier and Type | Class and Description |
---|---|
class |
ScreenFullscreenAction
This
DockAction is mainly used by the ScreenDockStation
to allow it's children to go into fullscreen-mode. |
Modifier and Type | Method and Description |
---|---|
DockAction |
FullscreenActionSource.getDockAction(int index) |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<DockAction> |
FullscreenActionSource.iterator() |
Constructor and Description |
---|
FullscreenActionSource(DockAction action,
LocationHint hint)
Creates a new source.
|
Modifier and Type | Class and Description |
---|---|
class |
SplitFullScreenAction
This
DockAction is mainly used by the SplitDockStation
to allow it's children to get in fullscreen-mode. |
Modifier and Type | Method and Description |
---|---|
DockAction |
DockActionDistributorSource.getDockAction(int index) |
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<DockAction> |
DockActionDistributorSource.iterator() |
Modifier and Type | Class and Description |
---|---|
class |
AbstractBasicHandler<D extends DockAction,M extends BasicButtonModel>
Collection of methods that are interesting for classes that wrap around a
BasicButtonModel . |
Modifier and Type | Method and Description |
---|---|
DockAction |
BasicButtonModel.getAction()
Gets the
DockAction which is handled by this model. |
DockAction |
BasicSeparatorHandler.getAction() |
DockAction |
BasicTrigger.getAction()
Gets the
DockAction which will be triggered by this object. |
Modifier and Type | Method and Description |
---|---|
protected double |
DefaultDockActionImportanceOrder.getImportance(DockAction action)
Tells how important
action is. |
void |
DefaultDockActionImportanceOrder.order(DockAction[] actions) |
void |
DockActionImportanceOrder.order(DockAction[] actions)
Sorts the actions by their important, the most important action
has to be at index
0 , while the least important action
is at index actions.length-1 . |
Constructor and Description |
---|
DropDownItemHandle(DockAction item,
DropDownViewItem view,
Dockable dockable,
DropDownAction action)
Creates a new item.
|
Modifier and Type | Method and Description |
---|---|
protected BasicTitleViewItem<javax.swing.JComponent> |
ButtonPanel.createItemFor(DockAction action,
Dockable dockable)
Creates a new item for
action which will be shown on this panel. |
Modifier and Type | Method and Description |
---|---|
DockAction |
SubDropDownHandler.getAction() |
Modifier and Type | Method and Description |
---|---|
DockAction |
DropDownMenuHandler.getAction() |
Modifier and Type | Method and Description |
---|---|
MenuViewItem<javax.swing.JComponent> |
MenuMenuHandler.getViewFor(DockAction action)
Searches for the first view which is used for
action . |
protected MenuViewItem<javax.swing.JComponent> |
MenuMenuHandler.handlerFor(DockAction action)
Creates a new view for
action . |
Modifier and Type | Method and Description |
---|---|
DockAction |
ActionColor.getAction()
Gets the action for which this color is used.
|
Constructor and Description |
---|
ActionColor(java.lang.String id,
Dockable dockable,
DockAction action,
java.awt.Color backup)
Creates a new
DockColor . |
ActionColor(java.lang.String id,
Path kind,
Dockable dockable,
DockAction action,
java.awt.Color backup)
Creates a new
DockColor . |
Modifier and Type | Method and Description |
---|---|
DockAction |
ButtonFont.getAction()
Gets the action for which this font is used.
|
Constructor and Description |
---|
ButtonFont(java.lang.String id,
Dockable dockable,
DockAction action,
FontModifier backup)
Creates a new font
|
ButtonFont(java.lang.String id,
Dockable dockable,
DockAction action,
Path kind,
FontModifier backup)
Creates a new font
|
Modifier and Type | Method and Description |
---|---|
protected BasicTitleViewItem<javax.swing.JComponent> |
AbstractMultiDockTitle.createItemFor(DockAction action,
Dockable dockable)
Creates a new item for
action which will be shown on this title. |