Package org.flexdock.docking
Interface DockableFactory
-
- All Known Implementing Classes:
DockableFactory.Stub
public interface DockableFactoryThis interface is designed to provide an API for allowing theDockingManagerto obtainDockableinstances on the fly. It has a single method,getDockableComponent(String dockableId), responsible for returningComponentinstances, possibly creating and registeringDockablesin the process. Implementations of this interface will be application-specific and may be plugged into theDockingManagervia the callDockingManager.setDockableFactory(myFactory). Throughout the framework, FlexDock makes many calls toDockingManager.getDockable(String id)under the assumption that at some point, the requestedDockableinstance has been registered viaDockingManager.registerDockable(Dockable dockable). In the event that aDockablewith the specified ID has never been formally registered, theDockingManagerwill check for a factory viaDockingManager.getDockableFactory(). If a factory is present, itsgetDockableComponent()method is invoked. If a validComponentis returned fromgetDockableComponent(), the DockingManager will attempt to register it as aDockableand return theDockable.DockableFactoryimplementations are especially useful for applications with persisted layouts where theDockablesrequired during a layout restoration may be constructed automatically on demand by the framework.- Author:
- Christopher Butler
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classDockableFactory.StubAn empty implementation ofDockableFactory.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DockablegetDockable(java.lang.String dockableId)Returns aDockablefor the specified Dockable ID, possibly creating and registering it in the process.java.awt.ComponentgetDockableComponent(java.lang.String dockableId)Returns aComponentfor the specified Dockable ID, possibly creating and registering aDockablein the process.
-
-
-
Method Detail
-
getDockableComponent
java.awt.Component getDockableComponent(java.lang.String dockableId)
Returns aComponentfor the specified Dockable ID, possibly creating and registering aDockablein the process.- Parameters:
dockableId- the ID for the requested dockableComponent- Returns:
- the
Componentfor the specified ID
-
getDockable
Dockable getDockable(java.lang.String dockableId)
Returns aDockablefor the specified Dockable ID, possibly creating and registering it in the process.- Parameters:
dockableId- the ID for the requestedDockable- Returns:
- the
Dockablefor the specified ID
-
-