Package | Description |
---|---|
bibliothek.gui.dock.common |
A set of classes that can be used to create basic applications.
|
bibliothek.gui.dock.common.event | |
bibliothek.gui.dock.common.group |
Contains the
CGroupBehavior and its implementations,
this interface allows to group Dockable s together. |
bibliothek.gui.dock.common.grouping | |
bibliothek.gui.dock.common.intern |
Classes and interfaces used internally.
|
bibliothek.gui.dock.common.intern.action |
CAction s and supporting classes that are not intended for clients
to be used directly. |
bibliothek.gui.dock.common.location |
Various implementations of
CLocation . |
bibliothek.gui.dock.common.mode | |
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.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.status |
Strategies helping a
LocationModeManager to decide which modes are
available for a Dockable . |
Modifier and Type | Method and Description |
---|---|
abstract ExtendedMode |
CLocation.findMode()
Gets the mode this location represents.
|
Modifier and Type | Method and Description |
---|---|
CStation<?> |
CContentArea.getDefaultStation(ExtendedMode mode) |
CStation<?> |
CStationContainer.getDefaultStation(ExtendedMode mode)
Gets the preferred default
CStation of this container for children in mode mode . |
java.util.List<CDockable> |
CControlRegister.listDockablesInMode(ExtendedMode mode)
Gets a list of all visible
CDockable s in the given mode. |
Modifier and Type | Method and Description |
---|---|
void |
CDockableAdapter.extendedModeChanged(CDockable dockable,
ExtendedMode mode) |
void |
CDockableStateListener.extendedModeChanged(CDockable dockable,
ExtendedMode mode)
Called if the
extended mode of dockable
changed. |
void |
CDockableAdapter.modeChanged(CDockable dockable,
ExtendedMode mode)
Called by
CDockableAdapter.extendedModeChanged(CDockable, ExtendedMode) if none of the
default modes was selected |
Modifier and Type | Method and Description |
---|---|
Dockable |
CGroupBehavior.getGroupElement(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode mode)
Gets the element whose location or mode must be changed in order to apply
mode to dockable . |
Dockable |
StackGroupBehavior.getGroupElement(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode mode) |
Dockable |
TopMostGroupBehavior.getGroupElement(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode mode) |
Dockable |
CGroupBehavior.getReplaceElement(LocationModeManager<? extends LocationMode> manager,
Dockable old,
Dockable dockable,
ExtendedMode mode)
Gets the element which would replace
old if old is currently
in mode , and dockable is or will not be in mode . |
Dockable |
StackGroupBehavior.getReplaceElement(LocationModeManager<? extends LocationMode> manager,
Dockable old,
Dockable dockable,
ExtendedMode mode) |
Dockable |
TopMostGroupBehavior.getReplaceElement(LocationModeManager<? extends LocationMode> manager,
Dockable old,
Dockable dockable,
ExtendedMode mode) |
CGroupMovement |
CGroupBehavior.prepare(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode target)
Calculates how the mode of
dockable has to be changed such that it matches target . |
CGroupMovement |
StackGroupBehavior.prepare(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode target) |
CGroupMovement |
TopMostGroupBehavior.prepare(LocationModeManager<? extends LocationMode> manager,
Dockable dockable,
ExtendedMode target) |
void |
CGroupBehaviorCallback.setMode(Dockable dockable,
ExtendedMode mode)
Sets the
ExtendedMode of dockable using all available
history information.Note: LocationMode s may decide that more than one Dockable must be moved
in order to accomplish the goal, any cached location information about Dockable s should be
considered invalid once this method has been executed. |
boolean |
CGroupBehavior.shouldForwardActions(LocationModeManager<? extends LocationMode> manager,
DockStation station,
Dockable dockable,
ExtendedMode mode)
Tells whether the actions of
dockable for mode mode should be
shown on station too. |
boolean |
StackGroupBehavior.shouldForwardActions(LocationModeManager<? extends LocationMode> manager,
DockStation station,
Dockable dockable,
ExtendedMode mode) |
boolean |
TopMostGroupBehavior.shouldForwardActions(LocationModeManager<? extends LocationMode> manager,
DockStation station,
Dockable dockable,
ExtendedMode mode) |
Constructor and Description |
---|
SingleGroupMovement(Dockable dockable,
ExtendedMode target)
Creates a new movement object.
|
StackGroupMovement(StackDockStation dockParent,
Dockable dockable,
ExtendedMode target)
Creates a new movement object.
|
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
DockableGrouping.getInitialMode(Dockable dockable)
Tries to find out how to display
dockable initially. |
ExtendedMode |
PlaceholderGrouping.getInitialMode(Dockable dockable) |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
AbstractCDockable.getExtendedMode() |
ExtendedMode |
CDockable.getExtendedMode()
Gets the size and location of this
CDockable . |
Modifier and Type | Method and Description |
---|---|
CLocation |
AbstractCDockable.getDefaultLocation(ExtendedMode mode)
Gets an earlier set value of
AbstractCDockable.setDefaultLocation(ExtendedMode, CLocation) . |
void |
CDockableAccess.informMode(ExtendedMode mode)
Called after the mode of the
CDockable may have changed. |
java.util.List<CDockable> |
DefaultCControlRegister.listDockablesInMode(ExtendedMode mode)
Gets a list of all visible
CDockable s in the given mode. |
void |
AbstractCDockable.setDefaultLocation(ExtendedMode mode,
CLocation location)
Sets the default location for mode
mode for this dockable. |
void |
AbstractCDockable.setExtendedMode(ExtendedMode extendedMode) |
void |
CDockable.setExtendedMode(ExtendedMode extendedMode)
Sets how and where this
CDockable should be shown. |
Modifier and Type | Method and Description |
---|---|
protected void |
CExtendedModeAction.init(CControl control,
ExtendedMode mode,
java.lang.String iconKey,
java.lang.String textKey,
java.lang.String tooltipKey,
PropertyKey<javax.swing.KeyStroke> gotoStroke)
Creates a new action, this method must be called only once.
|
Constructor and Description |
---|
CExtendedModeAction(CControl control,
ExtendedMode mode,
java.lang.String iconKey,
java.lang.String textKey,
java.lang.String tooltipKey,
PropertyKey<javax.swing.KeyStroke> gotoStroke)
Creates a new action.
|
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
AbstractTreeLocation.findMode() |
ExtendedMode |
CBaseLocation.findMode() |
ExtendedMode |
CExtendedModeLocation.findMode() |
ExtendedMode |
CExternalizedLocation.findMode() |
ExtendedMode |
CFlapIndexLocation.findMode() |
ExtendedMode |
CFlapLocation.findMode() |
ExtendedMode |
CMaximalExternalizedLocation.findMode() |
ExtendedMode |
CMaximizedLocation.findMode() |
ExtendedMode |
CMinimizedLocation.findMode() |
ExtendedMode |
CRectangleLocation.findMode() |
ExtendedMode |
CSplitLocation.findMode() |
ExtendedMode |
CStackLocation.findMode() |
ExtendedMode |
CWorkingAreaLocation.findMode() |
ExtendedMode |
TreeLocationLeaf.findMode() |
Constructor and Description |
---|
CExtendedModeLocation(ExtendedMode mode)
Creates a new location.
|
Modifier and Type | Field and Description |
---|---|
static ExtendedMode |
ExtendedMode.EXTERNALIZED
the dockable is floating in a dialog, see also
ExternalizedMode |
static ExtendedMode |
ExtendedMode.MAXIMIZED
the dockable is as big as possible, see also
MaximizedMode |
static ExtendedMode |
ExtendedMode.MINIMIZED
the dockable is as small as possible, see also
MinimizedMode |
static ExtendedMode |
ExtendedMode.NORMALIZED
the dockable has the normal size, see also
NormalMode |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
CLocationModeManager.childsExtendedMode(DockStation parent)
Guesses the result of
LocationModeManager.getCurrentMode(Dockable) once a Dockable is
dropped onto DockStation . |
ExtendedMode |
PreviousModeDoubleClickStrategy.handleDoubleClick(Dockable dockable,
ExtendedMode current,
ExtendedModeEnablement enablement) |
Modifier and Type | Method and Description |
---|---|
CLocation |
CLocationModeManager.getLocation(Dockable dockable,
ExtendedMode mode)
Assuming that
dockable is currently not in mode mode ,
then this method searches for the previously stored location of dockable . |
protected CStation<?> |
CStationContainerHistoryRewriter.getMatchingStation(Dockable dockable,
ExtendedMode mode)
|
ExtendedMode |
PreviousModeDoubleClickStrategy.handleDoubleClick(Dockable dockable,
ExtendedMode current,
ExtendedModeEnablement enablement) |
void |
CLocationModeManager.setLocation(Dockable dockable,
ExtendedMode mode,
CLocation location)
Sets the default location of
dockable when going into
mode . |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
LocationHistory.getLastMode()
Gets the newest entry of this history.
|
ExtendedMode |
LocationHistory.getMode(int index)
Gets the
index 'th entry of this history, where an
index of 0 represents the oldest entry. |
Modifier and Type | Method and Description |
---|---|
void |
LocationHistory.add(ExtendedMode mode,
Location location)
Sets the
location that is to be used for mode . |
Location |
LocationHistory.get(ExtendedMode mode)
Gets the location that is to be used for
mode . |
void |
LocationHistory.insert(int index,
ExtendedMode mode,
Location location)
Sets the
location that is to be used for mode . |
void |
LocationHistory.remove(ExtendedMode mode)
Removes any entries related to
mode . |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
CExternalizedModePerspective.getIdentifier() |
ExtendedMode |
CMaximizedModePerspective.getIdentifier() |
ExtendedMode |
CMinimizedModePerspective.getIdentifier() |
ExtendedMode |
CNormalModePerspective.getIdentifier() |
ExtendedMode |
LocationModePerspective.getIdentifier()
Gets the unique identifier for this mode.
|
ExtendedMode |
LocationModeManagerPerspective.getMode(Path identifier)
Gets the
ExtendedMode whose identifier is equal to
identifier . |
ExtendedMode |
LocationModeManagerPerspective.getMode(PerspectiveDockable dockable)
Gets the current mode of
dockable . |
ExtendedMode |
LocationModeManagerPerspective.getMode(java.lang.String root,
DockableProperty location)
Gets the mode which could have a child in the given location.
|
ExtendedMode[] |
LocationModeManagerPerspective.getModes()
Gets an array containing all the modes known to this manager.
|
Modifier and Type | Method and Description |
---|---|
LocationModePerspective |
LocationModeManagerPerspective.getMode(ExtendedMode mode)
Gets the location-mode with the identifier
mode . |
Modifier and Type | Method and Description |
---|---|
ExtendedMode |
ExternalizedMode.getExtendedMode() |
ExtendedMode |
LocationMode.getExtendedMode()
Gets the unique identifier of this mode.
|
ExtendedMode |
MaximizedMode.getExtendedMode() |
ExtendedMode |
MinimizedMode.getExtendedMode() |
ExtendedMode |
NormalMode.getExtendedMode() |
ExtendedMode |
LocationModeManager.getMode(Dockable dockable)
Gets the current mode of
dockable . |
ExtendedMode |
DoubleClickLocationStrategy.handleDoubleClick(Dockable dockable,
ExtendedMode current,
ExtendedModeEnablement enablement)
Called if the user double-clicked on
dockable . |
Modifier and Type | Method and Description |
---|---|
java.util.Map<ExtendedMode,DockStation> |
LocationModeManager.getRepresentations(java.lang.String id)
Checks all
LocationMode s of this manager and returns all
DockStation s that were registered with the given id. |
Modifier and Type | Method and Description |
---|---|
void |
LocationModeManager.apply(Dockable dockable,
ExtendedMode extendedMode,
CGroupMovement action)
Executes
action in a transaction assuming that the result of this action will lead to
dockable having the new mode extendedMode . |
ExtendedMode |
DoubleClickLocationStrategy.handleDoubleClick(Dockable dockable,
ExtendedMode current,
ExtendedModeEnablement enablement)
Called if the user double-clicked on
dockable . |
boolean |
LocationModeManager.isModeAvailable(Dockable dockable,
ExtendedMode mode)
Using the current
ExtendedModeEnablement this method tells whether
mode mode can be applied to dockable . |
boolean |
LocationModeManager.isModeHidden(Dockable dockable,
ExtendedMode mode)
Using the current
ExtendedModeEnablement this method tells whether
mode mode is hidden from the user when looking at dockable . |
void |
LocationModeManager.setMode(Dockable dockable,
ExtendedMode extendedMode)
Sets the current mode of
dockable . |
Modifier and Type | Method and Description |
---|---|
void |
ExtendedModeEnablementListener.availabilityChanged(Dockable dockable,
ExtendedMode mode,
boolean available)
Called if the state changed.
|
protected void |
AbstractExtendedModeEnablement.fire(Dockable dockable,
ExtendedMode mode,
boolean available)
Calls
ExtendedModeEnablementListener.availabilityChanged(Dockable, ExtendedMode, boolean) for
all listeners that are registered. |
ExtendedModeEnablement.Availability |
DefaultExtendedModeEnablement.isAvailable(Dockable dockable,
ExtendedMode mode) |
ExtendedModeEnablement.Availability |
ExtendedModeEnablement.isAvailable(Dockable dockable,
ExtendedMode mode)
Tells whether
mode is available for dockable .Note: for NORMALIZED the result should always be true . |
ExtendedModeEnablement.Hidden |
DefaultExtendedModeEnablement.isHidden(Dockable dockable,
ExtendedMode mode) |
ExtendedModeEnablement.Hidden |
ExtendedModeEnablement.isHidden(Dockable dockable,
ExtendedMode mode)
Tells whether
mode is hidden from the user for dockable . |
protected ExtendedModeEnablement.Availability |
DefaultExtendedModeEnablement.isModeAvailable(Dockable dockable,
ExtendedMode mode)
The actual implementation of
ExtendedModeEnablement.isAvailable(Dockable, ExtendedMode) |