public class ExternalizingCGridAreaConfiguration
extends java.lang.Object
ExternalizingCGridAreaConfiguration
is a piece of code responsible for changing the behavior
of the framework such that externalized CDockable
are not stacked, but put in a ExternalizingCGridArea
.install()
, installOn(CControl)
and uninstall()
to activate or
deactivate this configuration.Modifier and Type | Class and Description |
---|---|
protected class |
ExternalizingCGridAreaConfiguration.SplitInserter
A listener that is added to a
ScreenDockStation , every time some Dockable is added to said
station, a new ExternalizingCGridArea is created and inserted. |
Constructor and Description |
---|
ExternalizingCGridAreaConfiguration(CControl control)
Creates a new configuration.
|
Modifier and Type | Method and Description |
---|---|
protected ExternalizingCGridArea |
createGridArea()
Creates a new
ExternalizingCGridArea , the identifier of the new station is unique compared to all
the CDockable s that are currently registered at control . |
protected ExternalizingCGridAreaConfiguration.SplitInserter |
createSplitInserter()
Creates a new instance of
ExternalizingCGridAreaConfiguration.SplitInserter . |
CControl |
getControl()
Gets the
CControl for which this configuration is used. |
protected DockStation |
getScreenDockStation()
Gets the
DockStation which was registered with the name CControl.EXTERNALIZED_STATION_ID . |
protected ExternalizingCGridAreaConfiguration.SplitInserter |
getSplitInserter()
Gets the listener that is responsible for inserting new
ExternalizingCGridArea s. |
void |
install()
Activates this configuration.
|
static ExternalizingCGridAreaConfiguration |
installOn(CControl control)
Creates a new
ExternalizingCGridAreaConfiguration and installs it. |
void |
uninstall()
Deactivates this configuration, existing
ExternalizingCGridArea s will not be cleaned up. |
public ExternalizingCGridAreaConfiguration(CControl control)
control
- the control for which this configuration will be used, not null
public static ExternalizingCGridAreaConfiguration installOn(CControl control)
ExternalizingCGridAreaConfiguration
and installs
it.control
- the control in whose realm this configuration is usedprotected ExternalizingCGridAreaConfiguration.SplitInserter getSplitInserter()
ExternalizingCGridArea
s.null
protected ExternalizingCGridAreaConfiguration.SplitInserter createSplitInserter()
ExternalizingCGridAreaConfiguration.SplitInserter
.null
public CControl getControl()
CControl
for which this configuration is used.CControl
protected ExternalizingCGridArea createGridArea()
ExternalizingCGridArea
, the identifier of the new station is unique compared to all
the CDockable
s that are currently registered at control
.null
public void install()
public void uninstall()
ExternalizingCGridArea
s will not be cleaned up.protected DockStation getScreenDockStation()
DockStation
which was registered with the name CControl.EXTERNALIZED_STATION_ID
.ExternalizingCGridArea
s