@FrameworkOnly public interface CControlAccess
CControl
.CControl
.Modifier and Type | Method and Description |
---|---|
CDockableAccess |
access(CDockable dockable)
Grants access to the internal methods of a
CDockable . |
DockAction |
createCloseAction(CDockable dockable)
Gets an action that closes
dockable when clicked. |
CLocation |
getAutoBaseLocation(CDockable dockable,
boolean noBackwardTransformation)
Gets the default result for
CDockable.getAutoBaseLocation(boolean) . |
java.lang.String |
getFactoryId(MultipleCDockableFactory<?,?> factory)
Gets the id of
factory . |
CLocationModeManager |
getLocationManager()
Gets the manager that is responsible to change the extended mode of the
Dockable s. |
CControl |
getOwner()
Gets the control to which this object gives access.
|
MutableCControlRegister |
getRegister()
Gets the mutable register of the
CControl . |
boolean |
hasParent(CDockable dockable)
Tells whether
dockable has a parent and is registered. |
void |
hide(CDockable dockable)
Makes
dockable invisible. |
boolean |
isVisible(CDockable dockable)
Tells whether
dockable is visible or not. |
void |
link(CDockable dockable,
CDockableAccess access)
Gives or removes access to internal properties of an
CDockable . |
java.lang.String |
shouldStore(CDockable dockable)
Tells whether information about
dockable should remain stored even if
the element is removed from the CControl . |
boolean |
shouldStore(java.lang.String key)
|
void |
show(CDockable dockable)
Makes
dockable visible. |
CControl getOwner()
void show(CDockable dockable)
dockable
visible.dockable
- the element that will be made visiblevoid hide(CDockable dockable)
dockable
invisible.dockable
- the element that will be made invisibleboolean isVisible(CDockable dockable)
dockable
is visible or not.dockable
- the dockable whose visibility-state is in questiontrue
if dockable
is visibleboolean hasParent(CDockable dockable)
dockable
has a parent and is registered.dockable
- the dockable to checktrue
if dockable
is in the tree and not a rootjava.lang.String getFactoryId(MultipleCDockableFactory<?,?> factory)
factory
.factory
- the factory to searchnull
CLocationModeManager getLocationManager()
Dockable
s.DockAction createCloseAction(CDockable dockable)
dockable
when clicked.dockable
- the element to closevoid link(CDockable dockable, CDockableAccess access)
CDockable
.dockable
- the element which changes its accessaccess
- the new access, might be null
CDockableAccess access(CDockable dockable)
CDockable
.dockable
- the element whose access is searchednull
boolean shouldStore(java.lang.String key)
key
- the key for which a dockable might be storedtrue
if layout information for key
should
be stored, false
otherwisejava.lang.String shouldStore(CDockable dockable)
dockable
should remain stored even if
the element is removed from the CControl
.dockable
- the element to checknull
if nothing should be stored, the unique encoded identifier of dockable
if data should remain storedMutableCControlRegister getRegister()
CControl
. Note that clients should
only query this register, but not change anything in it.CLocation getAutoBaseLocation(CDockable dockable, boolean noBackwardTransformation)
CDockable.getAutoBaseLocation(boolean)
.dockable
- the element whose location is searchednoBackwardTransformation
- if true
, then no DockableProperty
should be converted to a CLocation
null
if not available