@FrameworkOnly public class CDockFrontend extends DockFrontend
DockFrontend.DockInfo, DockFrontend.Hider, DockFrontend.RootInfo
DOCKABLE_KEY_PREFIX, FRONTEND_EXTENSION, HIDE_ACCELERATOR, ROOT_KEY_PREFIX
Constructor and Description |
---|
CDockFrontend(CControlAccess control,
DockController controller)
Creates a new frontend.
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(CDockFrontendListener listener)
Adds
listener to this frontend, listener will be informed
about changes of this frontend. |
protected Setting |
createSetting()
Creates a bag that contains all information needed to describe the
current set of properties.
|
protected CDockFrontendListener[] |
frontendListeners()
Gets all the listeners that are registered at this frontend.
|
Setting |
getSetting(boolean entry)
Creates a new
Setting which describes the current set of
properties of this frontend. |
boolean |
isRevertToBasicModes()
Tells whether only basic modes are allowed after loading a layout.
|
void |
remove(Dockable dockable)
Removes a
Dockable which was earlier added to this frontend. |
void |
removeListener(CDockFrontendListener listener)
Removes
listener from this frontend. |
void |
setRevertToBasicModes(boolean revertToBasicModes)
If set, then loading a layout will trigger a call to
CLocationModeManager.ensureBasicModes() . |
void |
setSetting(Setting setting,
boolean entry)
Changes the content of all root-stations according to
setting .This method may add new empty infos if it finds
information for a non existing, non empty Dockable but whose
key passes the methods of MissingDockableStrategy . |
addDockable, addEmpty, addFrontendListener, addRepresentative, addRoot, addRoot, addVetoableListener, clean, clean, createHider, createPropertyTransformer, delete, deleteAll, fireAdded, fireAllHidden, fireAllShown, fireDeleted, fireHidden, fireHideable, fireLoaded, fireRead, fireRemoved, fireSaved, fireShown, getController, getCurrentSetting, getDefaultStation, getDockable, getDockables, getDockFactory, getDockProperties, getFrontendEntry, getFrontendEntry, getHider, getIgnoreForEntry, getIgnoreForFinal, getLastAppliedEntrySetting, getLastAppliedFullSetting, getLayoutChangeStrategy, getMissingDockable, getNamedDockables, getNameOf, getOwner, getPerspective, getPerspective, getRoot, getRootNames, getRoots, getSetting, getSettings, hasLocation, hasLocation, hide, hide, isDefaultEntryLayout, isDefaultHideable, isEmpty, isEntryLayout, isEntryLayout, isHidden, isHiddenRootStation, isHideable, isShowHideAction, isShown, kill, listDockables, listEmpty, listeners, listFrontendEntries, listShownDockables, load, load, read, read, read, readBlop, readBlop, readBlopXML, readXML, readXML, readXML, registerAdjacentFactory, registerBackupFactory, registerFactory, registerFactory, registerFactory, removeEmpty, removeFrontendListener, removeRepresentative, removeRoot, removeVetoableListener, save, save, save, setCurrentSetting, setCurrentSettingName, setDefaultEntryLayout, setDefaultHideable, setDefaultStation, setEntryLayout, setEntryLayout, setHideable, setIgnoreForEntry, setIgnoreForFinal, setLayoutChangeStrategy, setLocationAside, setMissingDockableStrategy, setOwner, setSetting, setShowHideAction, show, show, unregisterAdjacentFactory, unregisterBackupFactory, unregisterFactory, write, write, writeBlop, writeBlop, writeBlopXML, writeXML, writeXML
public CDockFrontend(CControlAccess control, DockController controller)
control
- the owner of this objectcontroller
- the controller to usepublic void addListener(CDockFrontendListener listener)
listener
to this frontend, listener
will be informed
about changes of this frontend.listener
- the listener to add, not null
protected CDockFrontendListener[] frontendListeners()
public void removeListener(CDockFrontendListener listener)
listener
from this frontend.listener
- the listener to removepublic void setRevertToBasicModes(boolean revertToBasicModes)
CLocationModeManager.ensureBasicModes()
.revertToBasicModes
- whether to allow only basic modes after loadingpublic boolean isRevertToBasicModes()
true
if non-basic modes are forbiddenpublic void remove(Dockable dockable)
DockFrontend
Dockable
which was earlier added to this frontend.remove
in class DockFrontend
dockable
- the element to removeprotected Setting createSetting()
DockFrontend
createSetting
in class DockFrontend
public Setting getSetting(boolean entry)
DockFrontend
Setting
which describes the current set of
properties of this frontend. The setting contains information about
the location of each Dockable
.getSetting
in class DockFrontend
entry
- true
if only the information for an ordinary
entry should be stored, false
if the setting should contain
as much information as possible.DockFrontend.createSetting()
public void setSetting(Setting setting, boolean entry)
DockFrontend
setting
.empty infos
if it finds
information for a non existing, non empty Dockable
but whose
key passes the methods of MissingDockableStrategy
.setSetting
in class DockFrontend
setting
- a new set of propertiesentry
- true
if only information for an ordinary
entry should be extracted, false
if as much information
as possible should be extracted. The value of this argument should
be the same as was used when DockFrontend.getSetting(boolean)
was called.