Package org.flexdock.perspective
Class PerspectiveManager
- java.lang.Object
-
- org.flexdock.perspective.PerspectiveManager
-
- All Implemented Interfaces:
LayoutManager
public class PerspectiveManager extends java.lang.Object implements LayoutManager
- Author:
- Mateusz Szczap
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_PERSISTENCE_KEY_VALUEstatic java.lang.StringEMPTY_PERSPECTIVE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(Perspective perspective)voidadd(Perspective perspective, boolean isDefault)voidaddListener(PerspectiveListener perspectiveListener)LayoutNodecreateLayout(DockingPort port)PerspectivecreatePerspective(java.lang.String perspectiveId)booleandisplay(Dockable dockable)PerspectivegetCurrentPerspective()java.lang.StringgetCurrentPerspectiveName()java.lang.StringgetDefaultPersistenceKey()PerspectivegetDefaultPerspective()DockingStategetDockingState(java.lang.String dockable)DockingStategetDockingState(java.lang.String dockable, boolean load)DockingStategetDockingState(Dockable dockable)DockingStategetDockingState(Dockable dockable, boolean load)FloatManagergetFloatManager()static PerspectiveManagergetInstance()static RootWindowgetMainApplicationWindow()static DockingPortgetMainDockingPort()static PersistenceHandlergetPersistenceHandler()PerspectivegetPerspective(java.lang.String perspectiveId)PerspectiveListener[]getPerspectiveListeners()Perspective[]getPerspectives()static booleanisRestoreFloatingOnLoad()booleanload()booleanload(java.lang.String persistenceKey)voidloadPerspective()voidloadPerspective(java.lang.String perspectiveId)voidloadPerspective(java.lang.String perspectiveId, boolean reset)voidloadPerspective(java.lang.String perspectiveId, java.awt.Component window)voidloadPerspective(java.lang.String perspectiveId, java.awt.Component window, boolean reset)voidloadPerspective(java.lang.String perspectiveId, DockingPort rootPort)voidloadPerspective(java.lang.String perspectiveId, DockingPort rootPort, boolean reset)voidloadPerspectiveAsDefault(java.lang.String perspectiveId)voidloadPerspectiveAsDefault(java.lang.String perspectiveId, boolean reset)voidreload()voidreload(java.awt.Window w)PerspectiveManager#getMainApplicationWindow returns the first window where #getOwner == null.voidreload(java.awt.Window w, boolean reset)voidremove(java.lang.String perspectiveId)voidremoveListener(PerspectiveListener perspectiveListener)voidreset()voidreset(java.awt.Component window)voidreset(DockingPort rootPort)booleanrestore(boolean loadFromStorage)voidrestore(java.awt.Window w)voidsetCurrentPerspective(java.lang.String perspectiveId)voidsetCurrentPerspective(java.lang.String perspectiveId, boolean asDefault)voidsetDefaultPersistenceKey(java.lang.String key)voidsetDefaultPerspective(java.lang.String perspectiveId)static voidsetFactory(PerspectiveFactory factory)static voidsetPersistenceHandler(PersistenceHandler handler)static voidsetRestoreFloatingOnLoad(boolean restoreFloatingOnLoad)booleanstore()booleanstore(java.lang.String persistenceKey)
-
-
-
Field Detail
-
EMPTY_PERSPECTIVE
public static final java.lang.String EMPTY_PERSPECTIVE
- See Also:
- Constant Field Values
-
DEFAULT_PERSISTENCE_KEY_VALUE
public static final java.lang.String DEFAULT_PERSISTENCE_KEY_VALUE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstance
public static PerspectiveManager getInstance()
-
setFactory
public static void setFactory(PerspectiveFactory factory)
-
setPersistenceHandler
public static void setPersistenceHandler(PersistenceHandler handler)
-
getPersistenceHandler
public static PersistenceHandler getPersistenceHandler()
-
add
public void add(Perspective perspective)
-
add
public void add(Perspective perspective, boolean isDefault)
-
remove
public void remove(java.lang.String perspectiveId)
-
getPerspective
public Perspective getPerspective(java.lang.String perspectiveId)
-
createPerspective
public Perspective createPerspective(java.lang.String perspectiveId)
-
getPerspectives
public Perspective[] getPerspectives()
-
addListener
public void addListener(PerspectiveListener perspectiveListener)
-
removeListener
public void removeListener(PerspectiveListener perspectiveListener)
-
getPerspectiveListeners
public PerspectiveListener[] getPerspectiveListeners()
-
setDefaultPerspective
public void setDefaultPerspective(java.lang.String perspectiveId)
-
setCurrentPerspective
public void setCurrentPerspective(java.lang.String perspectiveId)
-
getCurrentPerspectiveName
public java.lang.String getCurrentPerspectiveName()
-
setCurrentPerspective
public void setCurrentPerspective(java.lang.String perspectiveId, boolean asDefault)
-
getDefaultPerspective
public Perspective getDefaultPerspective()
-
getCurrentPerspective
public Perspective getCurrentPerspective()
-
getDockingState
public DockingState getDockingState(Dockable dockable)
- Specified by:
getDockingStatein interfaceLayoutManager
-
getDockingState
public DockingState getDockingState(java.lang.String dockable)
- Specified by:
getDockingStatein interfaceLayoutManager
-
getDockingState
public DockingState getDockingState(Dockable dockable, boolean load)
-
getDockingState
public DockingState getDockingState(java.lang.String dockable, boolean load)
-
getFloatManager
public FloatManager getFloatManager()
- Specified by:
getFloatManagerin interfaceLayoutManager
-
reset
public void reset()
-
reset
public void reset(java.awt.Component window)
-
reset
public void reset(DockingPort rootPort)
-
reload
public void reload(java.awt.Window w)
PerspectiveManager#getMainApplicationWindow returns the first window where #getOwner == null. This is especially a problem for apps with multiple frames. To display a perspective for a specified window it is highly recommended to use #reload(Window w) instead of #reload() which is the same as DockingManager#restoreLayout(). You can use #restoreLayout when the application does not need multiple independent docking windows.
-
reload
public void reload(java.awt.Window w, boolean reset)
-
restore
public void restore(java.awt.Window w) throws java.io.IOException, PersistenceException- Throws:
java.io.IOExceptionPersistenceException
-
reload
public void reload()
-
loadPerspective
public void loadPerspective()
-
loadPerspectiveAsDefault
public void loadPerspectiveAsDefault(java.lang.String perspectiveId)
-
loadPerspectiveAsDefault
public void loadPerspectiveAsDefault(java.lang.String perspectiveId, boolean reset)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId, boolean reset)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId, java.awt.Component window)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId, java.awt.Component window, boolean reset)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId, DockingPort rootPort)
-
loadPerspective
public void loadPerspective(java.lang.String perspectiveId, DockingPort rootPort, boolean reset)
-
createLayout
public LayoutNode createLayout(DockingPort port)
- Specified by:
createLayoutin interfaceLayoutManager
-
display
public boolean display(Dockable dockable)
- Specified by:
displayin interfaceLayoutManager
-
store
public boolean store() throws java.io.IOException, PersistenceException- Specified by:
storein interfaceLayoutManager- Throws:
java.io.IOExceptionPersistenceException
-
store
public boolean store(java.lang.String persistenceKey) throws java.io.IOException, PersistenceException- Specified by:
storein interfaceLayoutManager- Throws:
java.io.IOExceptionPersistenceException
-
load
public boolean load() throws java.io.IOException, PersistenceException- Specified by:
loadin interfaceLayoutManager- Throws:
java.io.IOExceptionPersistenceException
-
load
public boolean load(java.lang.String persistenceKey) throws java.io.IOException, PersistenceException- Specified by:
loadin interfaceLayoutManager- Throws:
java.io.IOExceptionPersistenceException
-
isRestoreFloatingOnLoad
public static boolean isRestoreFloatingOnLoad()
-
setRestoreFloatingOnLoad
public static void setRestoreFloatingOnLoad(boolean restoreFloatingOnLoad)
-
getMainApplicationWindow
public static RootWindow getMainApplicationWindow()
-
getMainDockingPort
public static DockingPort getMainDockingPort()
-
restore
public boolean restore(boolean loadFromStorage) throws java.io.IOException, PersistenceException- Specified by:
restorein interfaceLayoutManager- Throws:
java.io.IOExceptionPersistenceException
-
getDefaultPersistenceKey
public java.lang.String getDefaultPersistenceKey()
- Specified by:
getDefaultPersistenceKeyin interfaceLayoutManager
-
setDefaultPersistenceKey
public void setDefaultPersistenceKey(java.lang.String key)
- Specified by:
setDefaultPersistenceKeyin interfaceLayoutManager
-
-