bibliothek.gui.dock.common.intern
Interface CControlAccess


public interface CControlAccess

Gives access to the internal methods of a CControl

Author:
Benjamin Sigg

Method Summary
 CDockableAccess access(CDockable dockable)
          Grants access to the internal methods of a CDockable.
<F extends MultipleCDockable>
F
add(F dockable, String uniqueId)
          Adds a dockable to this control.
 DockAction createCloseAction(CDockable dockable)
          Gets an action that closes dockable when clicked.
 String getFactoryId(MultipleCDockableFactory<?,?> factory)
          Gets the id of factory.
 CControl getOwner()
          Gets the control to which this object gives access.
 CStateManager getStateManager()
          Gets the manager that is responsible to change the states of the Dockables.
 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.
 void show(CDockable dockable)
          Makes dockable visible.
 

Method Detail

getOwner

CControl getOwner()
Gets the control to which this object gives access.

Returns:
the owner

add

<F extends MultipleCDockable> F add(F dockable,
                                    String uniqueId)
Adds a dockable to this control. The dockable can be made visible afterwards.

Type Parameters:
F - the type of the new element
Parameters:
dockable - the new element to show
uniqueId - id the unique id of the new element
Returns:
dockable

show

void show(CDockable dockable)
Makes dockable visible.

Parameters:
dockable - the element that will be made visible

hide

void hide(CDockable dockable)
Makes dockable invisible.

Parameters:
dockable - the element that will be made invisible

isVisible

boolean isVisible(CDockable dockable)
Tells whether dockable is visible or not.

Parameters:
dockable - the dockable whose visibility-state is in question
Returns:
true if dockable is visible

getFactoryId

String getFactoryId(MultipleCDockableFactory<?,?> factory)
Gets the id of factory.

Parameters:
factory - the factory to search
Returns:
the id or null

getStateManager

CStateManager getStateManager()
Gets the manager that is responsible to change the states of the Dockables.

Returns:
the manager

createCloseAction

DockAction createCloseAction(CDockable dockable)
Gets an action that closes dockable when clicked.

Parameters:
dockable - the element to close
Returns:
the action

link

void link(CDockable dockable,
          CDockableAccess access)
Gives or removes access to internal properties of an CDockable.

Parameters:
dockable - the element which changes its access
access - the new access, might be null

access

CDockableAccess access(CDockable dockable)
Grants access to the internal methods of a CDockable.

Parameters:
dockable - the element whose access is searched
Returns:
the access or null