Package org.flexdock.docking.state
Interface FloatManager
-
- All Known Implementing Classes:
FloatManager.Stub
,Layout
public interface FloatManager
This interface defines the API used for floating and groupingDockables
. Classes implementing this interface will be responsible for sendingDockables
intoDockingFrames
and managing the grouping of floatingDockables
.
Sending aDockable
into a floatingDockingFrame
is relatively straightforward when supplied theDockable
and a dialog owner. However, state must be maintained for eachFloatingGroup
to allow the system to track whichDockables
share the same floating dialog. If a floatingDockable
is closed and subsequently restored to its previous floating state, theFloatManager
must be able to determine whether an existing dialog is already present or a new dialog must be created into which theDockable
may be restored.FloatingGroups
are used to track which dialogs contain whichDockables
.FloatManager
implementations must manage the addition to and removal ofDockables
from appropriateFloatingGroups
and, in turn, use theseFloatingGroups
to resolve or create the necessaryDockingFrames
during float-operations.- Author:
- Christopher Butler
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
FloatManager.Stub
-
Field Summary
Fields Modifier and Type Field Description static FloatManager
DEFAULT_STUB
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addToGroup(Dockable dockable, java.lang.String groupId)
DockingFrame
floatDockable(Dockable dockable, java.awt.Component frameOwner)
DockingFrame
floatDockable(Dockable dockable, java.awt.Component frameOwner, java.awt.Rectangle screenBounds)
FloatingGroup
getGroup(java.lang.String groupName)
FloatingGroup
getGroup(Dockable dockable)
void
removeFromGroup(Dockable dockable)
-
-
-
Field Detail
-
DEFAULT_STUB
static final FloatManager DEFAULT_STUB
-
-
Method Detail
-
getGroup
FloatingGroup getGroup(java.lang.String groupName)
-
getGroup
FloatingGroup getGroup(Dockable dockable)
-
addToGroup
void addToGroup(Dockable dockable, java.lang.String groupId)
-
removeFromGroup
void removeFromGroup(Dockable dockable)
-
floatDockable
DockingFrame floatDockable(Dockable dockable, java.awt.Component frameOwner)
-
floatDockable
DockingFrame floatDockable(Dockable dockable, java.awt.Component frameOwner, java.awt.Rectangle screenBounds)
-
-