@Todo(priority=MAJOR, target=VERSION_1_1_2, compatibility=COMPATIBLE, description="The \'unmaximize\' button appears at the wrong location. And during drag and drop layout information is lost due to the listener that inserts the station after the dockable was inserted. Also perspectives will not yet work.") public class ExternalizingCGridArea extends CGridArea
CStation
is intended to be set between a ScreenDockStation
and a Dockable
.
It can clean up itself when it is no longer required.Modifier and Type | Field and Description |
---|---|
static Path |
TYPE_ID
The type of this area, returned by
getTypeId() |
static String |
UNIQUE_ID_PREFIX
Every unique identifier of a
ExternalizingCGridArea starts with this string |
listenerCollection
ACTION_KEY_CLOSE, ACTION_KEY_EXTERNALIZE, ACTION_KEY_MAXIMIZE, ACTION_KEY_MINIMIZE, ACTION_KEY_MINIMIZE_HOLD, ACTION_KEY_NORMALIZE, ACTION_KEY_UNEXTERNALIZE, ACTION_KEY_UNMAXIMIZE_EXTERNALIZED
Constructor and Description |
---|
ExternalizingCGridArea(CControl control)
Creates a new area.
|
ExternalizingCGridArea(CControl control,
String uniqueId)
Creates a new area.
|
Modifier and Type | Method and Description |
---|---|
protected ExternalizedCSplitDockStationHandler |
createSplitDockStationHandle(CControl control)
|
protected ExternalizedCSplitDockStationHandler |
getModeManagerHandle()
|
Path |
getTypeId()
Gets a unique path denoting the type of this station.
|
protected void |
install(CControlAccess access)
Called when this station is added to a
CControl . |
boolean |
isAutoRemove()
Tells whether this station can automatically remove itself from its parent and the
CControl . |
boolean |
isExternalizable()
Tells whether this
CDockable can be externalized by the user. |
boolean |
isMaximizable()
Tells whether this
CDockable can be maximized by the user. |
boolean |
isMinimizable()
Tells whether this
CDockable can be minimized by the user. |
boolean |
isNormalizeable()
Always
true , clients should not override this method unless they know exactly what they are doing. |
protected boolean |
isNormalizingArea()
Tells whether all children of this area are considered to be normalized.
|
void |
setAutoRemove(boolean autoRemove)
Sets whether this station can automatically delete itself from the application if the number of children
drops to
0 .The default value of this property is true . |
protected void |
tryAutoRemove()
Queues up a call to
autoRemove() |
protected void |
uninstall(CControlAccess access)
Called when this station is removed from a
CControl . |
asDockable, createCommonDockable, createPerspective, deploy, getComponent, getStation, getStationLocation, getTitleIcon, getTitleText, getUniqueId, init, isCloseable, isMaximizingArea, isStackable, isWorkingArea, setMaximizingArea, setTitleIcon, setTitleText, suppressTitle
asStation, getDropLocation, init, setControlAccess, toString
addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, control, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getClose, getColors, getControl, getControlAccess, getDefaultLocation, getDockableUniqueId, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, init, intern, isDockableVisible, isEnabled, isResizeLocked, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isSticky, isStickySwitchable, isTitleShown, isVisible, propertyListeners, putAction, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setDefaultLocation, setEnabled, setExtendedMode, setFocusComponent, setGrouping, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setResizeLocked, setResizeLockedHorizontally, setResizeLockedVertically, setResizeRequest, setResizeRequest, setSingleTabShown, setSticky, setStickySwitchable, setTitleShown, setVisible, setWorkingArea, stateListeners, toFront, toFront
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addCDockableLocationListener, addCDockablePropertyListener, addCDockableStateListener, addDoubleClickListener, addFocusListener, addKeyboardListener, addVetoClosingListener, asStation, getAction, getAndClearResizeRequest, getAutoBaseLocation, getBaseLocation, getColors, getControl, getControlAccess, getExtendedMode, getFocusComponent, getFonts, getGrouping, getMinimizedSize, getParentStation, getWorkingArea, hasParent, intern, isDockableVisible, isEnabled, isResizeLockedHorizontally, isResizeLockedVertically, isShowing, isSingleTabShown, isSticky, isStickySwitchable, isTitleShown, isVisible, removeCDockableLocationListener, removeCDockablePropertyListener, removeCDockableStateListener, removeDoubleClickListener, removeFocusListener, removeKeyboardListener, removeVetoClosingListener, setControlAccess, setExtendedMode, setLocation, setLocationsAside, setLocationsAside, setLocationsAsideFocused, setMinimizedSize, setSticky, setStickySwitchable, setVisible, setWorkingArea
public static final Path TYPE_ID
getTypeId()
public static final String UNIQUE_ID_PREFIX
ExternalizingCGridArea
starts with this stringpublic ExternalizingCGridArea(CControl control)
control
- the owner of this areaprotected ExternalizedCSplitDockStationHandler createSplitDockStationHandle(CControl control)
CGridArea
createSplitDockStationHandle
in class CGridArea
control
- the control in whose realm this area is usednull
protected ExternalizedCSplitDockStationHandler getModeManagerHandle()
CGridArea
getModeManagerHandle
in class CGridArea
this
as areaprotected void install(CControlAccess access)
AbstractDockableCStation
CControl
.protected void uninstall(CControlAccess access)
AbstractDockableCStation
CControl
.public boolean isMaximizable()
CDockable
CDockable
can be maximized by the user.isMaximizable
in interface CDockable
isMaximizable
in class CGridArea
true
if this element can be maximizedpublic boolean isExternalizable()
CDockable
CDockable
can be externalized by the user.isExternalizable
in interface CDockable
isExternalizable
in class CGridArea
true
if this element can be externalizedpublic boolean isMinimizable()
CDockable
CDockable
can be minimized by the user.isMinimizable
in interface CDockable
isMinimizable
in class CGridArea
true
if this element can be minimizedpublic boolean isNormalizeable()
AbstractCDockable
true
, clients should not override this method unless they know exactly what they are doing.isNormalizeable
in interface CDockable
isNormalizeable
in class AbstractCDockable
true
, unless a subclass requires very special behavior.protected boolean isNormalizingArea()
CGridArea
false
, then the default CSplitDockStationHandle
returned
by CGridArea.getModeManagerHandle()
will fail, clients must provide a custom implementation of
CSplitDockStationHandle
if they override this method.isNormalizingArea
in class CGridArea
public Path getTypeId()
CStation
MissingPerspectiveStrategy.createStation(String, Path)
when loading a layout
as a CPerspective
.getTypeId
in interface CStation<CSplitDockStation>
getTypeId
in class CGridArea
null
will just be ignored.public void setAutoRemove(boolean autoRemove)
0
.true
.autoRemove
- whether automatic cleanup is enabledpublic boolean isAutoRemove()
CControl
.setAutoRemove(boolean)
protected void tryAutoRemove()
autoRemove()