Package | Description |
---|---|
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.mode | |
bibliothek.gui.dock.common.mode.station |
Contains wrapper classes for various
DockStation s, implementing the interface
CLocationMode . |
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 . |
Modifier and Type | Method and Description |
---|---|
Location |
CGroupBehaviorCallback.getLocation(Dockable dockable)
Gets the current location of
dockable . |
Modifier and Type | Method and Description |
---|---|
void |
CGroupBehaviorCallback.setLocation(Dockable dockable,
Location location)
Sets the location of
dockable .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. |
Modifier and Type | Method and Description |
---|---|
protected Location |
PlaceholderGrouping.findLocationFor(Dockable dockable,
CLocationMode mode)
Searches a location for
dockable . |
protected Location |
PlaceholderGrouping.findLocationFor(Dockable dockable,
CLocationMode mode,
Location validatedHistory)
Called by
PlaceholderGrouping.getValidatedLocation(Dockable, CLocationMode, Location) , this method tries to find a location on the
root station designated by validatedHistory . |
Location |
DockableGrouping.getStoredLocation(Dockable dockable,
CLocationMode mode,
Location history)
Called right after an old location of
dockable for mode was read. |
Location |
PlaceholderGrouping.getStoredLocation(Dockable dockable,
CLocationMode mode,
Location history) |
Location |
DockableGrouping.getValidatedLocation(Dockable dockable,
CLocationMode mode,
Location validatedHistory)
Called right before
dockable is moved to a new location. |
Location |
PlaceholderGrouping.getValidatedLocation(Dockable dockable,
CLocationMode mode,
Location validatedHistory) |
Location |
GroupingHistoryRewriter.rewrite(Dockable dockable,
CLocationMode mode,
Location history) |
Modifier and Type | Method and Description |
---|---|
protected Location |
PlaceholderGrouping.findLocationFor(Dockable dockable,
CLocationMode mode,
Location validatedHistory)
Called by
PlaceholderGrouping.getValidatedLocation(Dockable, CLocationMode, Location) , this method tries to find a location on the
root station designated by validatedHistory . |
Location |
DockableGrouping.getStoredLocation(Dockable dockable,
CLocationMode mode,
Location history)
Called right after an old location of
dockable for mode was read. |
Location |
PlaceholderGrouping.getStoredLocation(Dockable dockable,
CLocationMode mode,
Location history) |
Location |
DockableGrouping.getValidatedLocation(Dockable dockable,
CLocationMode mode,
Location validatedHistory)
Called right before
dockable is moved to a new location. |
Location |
PlaceholderGrouping.getValidatedLocation(Dockable dockable,
CLocationMode mode,
Location validatedHistory) |
Location |
GroupingHistoryRewriter.rewrite(Dockable dockable,
CLocationMode mode,
Location history) |
Constructor and Description |
---|
GroupingHistoryRewriter(CControl control,
HistoryRewriter<Location,CLocationMode> validation)
Creates a new
GroupingHistoryRewriter . |
Modifier and Type | Method and Description |
---|---|
ModeSettings<Location,Location> |
CSetting.getModes()
Gets the set of modes.
|
ModeSettings<Location,Location> |
CSetting.getModes()
Gets the set of modes.
|
Modifier and Type | Method and Description |
---|---|
void |
CSetting.setModes(ModeSettings<Location,Location> modes)
Sets the set of modes.
|
void |
CSetting.setModes(ModeSettings<Location,Location> modes)
Sets the set of modes.
|
Modifier and Type | Method and Description |
---|---|
Location |
CStationContainerHistoryRewriter.rewrite(Dockable dockable,
CLocationMode mode,
Location history) |
Modifier and Type | Method and Description |
---|---|
<B> ModeSettings<Location,B> |
CLocationModeManager.createModeSettings(ModeSettingsConverter<Location,B> converter) |
Modifier and Type | Method and Description |
---|---|
CLocation |
CExternalizedMode.getCLocation(Dockable dockable,
Location location) |
CLocation |
CLocationMode.getCLocation(Dockable dockable,
Location location)
Gets the location of
dockable which might or might not
be a child of this mode. |
CLocation |
CMaximizedMode.getCLocation(Dockable dockable,
Location location) |
CLocation |
CMinimizedMode.getCLocation(Dockable dockable,
Location location) |
CLocation |
CModeArea.getCLocation(Dockable dockable,
Location location)
Assuming
dockable would be at location location
if it would be a child of this station, returns the CLocation that
matches location . |
CLocation |
CNormalMode.getCLocation(Dockable dockable,
Location location) |
MaximizedModeArea |
CMaximizedMode.getMaximizeArea(Dockable dockable,
Location history) |
Location |
CStationContainerHistoryRewriter.rewrite(Dockable dockable,
CLocationMode mode,
Location history) |
Modifier and Type | Method and Description |
---|---|
<B> ModeSettings<Location,B> |
CLocationModeManager.createModeSettings(ModeSettingsConverter<Location,B> converter) |
DockActionSource |
KeyedLocationModeActionProvider.getActions(Dockable dockable,
Mode<Location> currentMode,
DockActionSource currentSource) |
void |
CLocationModeManager.readSettings(ModeSettings<Location,?> settings) |
Runnable |
CLocationModeManager.readSettings(ModeSettings<Location,?> settings,
UndoableModeSettings pending) |
Modifier and Type | Method and Description |
---|---|
CLocation |
CFlapDockStationHandle.getCLocation(Dockable dockable,
Location location) |
CLocation |
CScreenDockStationHandle.getCLocation(Dockable dockable,
Location location)
Assuming dockable would be at location
location if it would be a child of this station,
returns the CLocation that matches location . |
CLocation |
CScreenDockStationHandle.External.getCLocation(Dockable dockable,
Location location) |
CLocation |
CScreenDockStationHandle.Maximal.getCLocation(Dockable dockable,
Location location) |
CLocation |
CSplitDockStationHandle.Normal.getCLocation(Dockable dockable,
Location location) |
CLocation |
CSplitDockStationHandle.Maximal.getCLocation(Dockable dockable,
Location location) |
CLocation |
ExternalizedCSplitDockStationHandler.Externalized.getCLocation(Dockable dockable,
Location location) |
void |
CScreenDockStationHandle.Maximal.prepareApply(Dockable dockable,
Location history,
AffectedSet set) |
void |
CSplitDockStationHandle.Maximal.prepareApply(Dockable dockable,
Location history,
AffectedSet set) |
void |
CScreenDockStationHandle.Maximal.setMaximized(Dockable dockable,
boolean maximized,
Location history,
AffectedSet set) |
void |
CSplitDockStationHandle.Maximal.setMaximized(Dockable dockable,
boolean maximized,
Location location,
AffectedSet set) |
Modifier and Type | Method and Description |
---|---|
Location |
LocationHistory.get(ExtendedMode mode)
Gets the location that is to be used for
mode . |
Location |
CPerspective.storeLocation(CDockablePerspective dockable)
Determines the current location of
dockable and stores that location
in a map using the ExtendedMode of the Location as key. |
Modifier and Type | Method and Description |
---|---|
Map<Path,Location> |
LocationHistory.getLocations()
Gets all the locations that are stored in this history.
|
Modifier and Type | Method and Description |
---|---|
void |
LocationHistory.add(ExtendedMode mode,
Location location)
Sets 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 . |
Modifier and Type | Method and Description |
---|---|
Location |
LocationModeManagerPerspective.getLocation(CDockablePerspective dockable)
Gets the current location of
dockable . |
Location |
LocationModeManagerPerspective.getLocation(PerspectiveDockable dockable)
Gets the current location of
dockable . |
Location |
CMaximizedModeAreaPerspective.getUnmaximizeLocation()
Gets the location the currently maximized item should use when unmaximized.
|
Modifier and Type | Method and Description |
---|---|
ModeSettings<Location,Location> |
LocationModeManagerPerspective.writeModes(CControlAccess control)
Writes the contents of this
LocationModeManagerPerspective into a new ModeSettings . |
ModeSettings<Location,Location> |
LocationModeManagerPerspective.writeModes(CControlAccess control)
Writes the contents of this
LocationModeManagerPerspective into a new ModeSettings . |
Modifier and Type | Method and Description |
---|---|
void |
CMaximizedModeAreaPerspective.setUnmaximize(Path mode,
Location location)
Sets the origin of the currently maximized child of this area.
|
Modifier and Type | Method and Description |
---|---|
void |
LocationModeManagerPerspective.readModes(ModeSettings<Location,?> modes,
CPerspective cperspective,
CControlAccess control)
Reads the contents of
modes and applies it to the dockables of cperspective . |
void |
AbstractModePerspective.readSetting(ModeSetting<Location> setting) |
void |
CMaximizedModePerspective.readSetting(ModeSetting<Location> setting) |
void |
LocationModePerspective.readSetting(ModeSetting<Location> setting)
Reads settings belonging to this mode from
setting . |
void |
AbstractModePerspective.writeSetting(ModeSetting<Location> setting) |
void |
CMaximizedModePerspective.writeSetting(ModeSetting<Location> setting) |
void |
LocationModePerspective.writeSetting(ModeSetting<Location> setting)
Writes settings that belong to this mode to
setting . |
Modifier and Type | Field and Description |
---|---|
static ModeSettingFactory<Location> |
MaximizedModeSetting.FACTORY
factory creating new
MaximizedModeSetting s |
Modifier and Type | Method and Description |
---|---|
Location |
AbstractLocationMode.aside(AsideRequest request,
Location location) |
Location |
LocationMode.aside(AsideRequest request,
Location location)
Calls
DockStation.aside(AsideRequest) on a station that matches location . |
Location |
LocationSettingConverter.convertToSetting(Location a) |
Location |
LocationSettingConverter.convertToWorld(Location b) |
Location |
DefaultLocationMode.current(Dockable dockable)
This default implementation just returns the location of
dockable but does not change any properties. |
Location |
MaximizedMode.current(Dockable dockable) |
Location |
LocationModeEvent.getLocation()
Gets the location which
dockable should have after
apply . |
Location |
LocationSettingConverter.readProperty(DataInputStream in) |
Location |
LocationSettingConverter.readPropertyXML(XElement element) |
Modifier and Type | Method and Description |
---|---|
Map<String,Location> |
MaximizedModeSetting.getLastMaximizedLocation()
Gets the location of
Dockable s that are currently maximized. |
ModeSettingFactory<Location> |
ExternalizedMode.getSettingFactory() |
ModeSettingFactory<Location> |
MaximizedMode.getSettingFactory() |
ModeSettingFactory<Location> |
MinimizedMode.getSettingFactory() |
ModeSettingFactory<Location> |
NormalMode.getSettingFactory() |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractLocationMode.apply(Dockable dockable,
Location history,
AffectedSet set) |
void |
LocationModeManager.apply(Dockable dockable,
M mode,
Location history,
AffectedSet set) |
Location |
AbstractLocationMode.aside(AsideRequest request,
Location location) |
Location |
LocationMode.aside(AsideRequest request,
Location location)
Calls
DockStation.aside(AsideRequest) on a station that matches location . |
Location |
LocationSettingConverter.convertToSetting(Location a) |
Location |
LocationSettingConverter.convertToWorld(Location b) |
MaximizedModeArea |
MaximizedMode.getMaximizeArea(Dockable dockable,
Location history)
Gets the area to which
dockable should be maximized. |
boolean |
MaximizedMode.maximize(MaximizedModeArea area,
Dockable dockable,
Location history,
AffectedSet set)
Ensures that
dockable is maximized. |
void |
MaximizedModeArea.prepareApply(Dockable dockable,
Location history,
AffectedSet set)
This method is called by
MaximizedMode just before the mode is applied
to dockable . |
protected abstract boolean |
AbstractLocationMode.runApply(Dockable dockable,
Location history,
AffectedSet set)
Called by
AbstractLocationMode.apply(Dockable, Location, AffectedSet) after the LocationModeListener s
are informed. |
boolean |
DefaultLocationMode.runApply(Dockable dockable,
Location history,
AffectedSet set)
This default implementation uses the
DockStation.move(Dockable, DockableProperty)
and DockStation.drop(Dockable, DockableProperty) methods to put
dockable at its location. |
boolean |
ExternalizedMode.runApply(Dockable dockable,
Location history,
AffectedSet set) |
boolean |
MaximizedMode.runApply(Dockable dockable,
Location history,
AffectedSet set) |
void |
MaximizedModeArea.setMaximized(Dockable dockable,
boolean maximized,
Location location,
AffectedSet set)
Tells this parent to change the maximization state of
dockable . |
void |
LocationSettingConverter.writeProperty(Location element,
DataOutputStream out) |
void |
LocationSettingConverter.writePropertyXML(Location b,
XElement element) |
Modifier and Type | Method and Description |
---|---|
DockActionSource |
DefaultLocationModeActionProvider.getActions(Dockable dockable,
Mode<Location> mode,
DockActionSource source) |
DockActionSource |
LocationModeActionProvider.getActions(Dockable dockable,
Mode<Location> currentMode,
DockActionSource currentSource)
Called if the element
dockable , which is currently in
mode mode , should have some additional DockAction s
related to the owner of this LocationModeActionProvider . |
DockActionSource |
MappingLocationModeActionProvider.getActions(Dockable dockable,
Mode<Location> currentMode,
DockActionSource currentSource) |
DockActionSource |
AbstractLocationMode.DockableHandle.getActions(Mode<Location> mode)
Called by
AbstractLocationMode.getActionsFor(Dockable, Mode)
to the actions related to this dockable. |
DockActionSource |
AbstractLocationMode.getActionsFor(Dockable dockable,
Mode<Location> mode) |
protected abstract LocationModeActionProvider |
MappingLocationModeActionProvider.getProvider(Dockable dockable,
Mode<Location> currentMode,
DockActionSource currentSource)
Gets the
LocationModeActionProvider which fits the key generated by the arguments
of this method. |
<B> void |
MaximizedModeSetting.read(DataInputStream in,
ModeSettingsConverter<Location,B> converter) |
<B> void |
MaximizedModeSetting.read(XElement element,
ModeSettingsConverter<Location,B> converter) |
void |
ExternalizedMode.readSetting(ModeSetting<Location> setting) |
void |
MaximizedMode.readSetting(ModeSetting<Location> setting) |
void |
MinimizedMode.readSetting(ModeSetting<Location> setting) |
void |
NormalMode.readSetting(ModeSetting<Location> setting) |
void |
MaximizedModeSetting.setLastMaximizedLocation(Map<String,Location> lastMaximizedLocation)
Sets the location of
Dockable s that are maximized. |
<B> void |
MaximizedModeSetting.write(DataOutputStream out,
ModeSettingsConverter<Location,B> converter) |
<B> void |
MaximizedModeSetting.write(XElement element,
ModeSettingsConverter<Location,B> converter) |
void |
ExternalizedMode.writeSetting(ModeSetting<Location> setting) |
void |
MaximizedMode.writeSetting(ModeSetting<Location> setting) |
void |
MinimizedMode.writeSetting(ModeSetting<Location> setting) |
void |
NormalMode.writeSetting(ModeSetting<Location> setting) |
Constructor and Description |
---|
LocationModeEvent(LocationMode mode,
Location location,
Dockable dockable,
AffectedSet affected)
Creates a new event.
|
Constructor and Description |
---|
CLocationModeSettings(ModeSettingsConverter<Location,B> converter)
Creates a new setting.
|