|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CDockable
A basic element representing some Component
.
Nested Class Summary | |
---|---|
static class |
CDockable.ExtendedMode
The mode tells how big a CDockable is. |
Method Summary | |
---|---|
void |
addCDockableListener(CDockableListener listener)
Adds a listener to this dockable, the listener will be informed of changes of this dockable. |
DockActionSource |
getClose()
Gets the source that contains the close-action. |
CControlAccess |
getControl()
Gets the control which is responsible for this dockable. |
CDockable.ExtendedMode |
getExtendedMode()
Gets the size and location of this dockable. |
CLocation |
getLocation()
Gets the location of this dockable. |
CWorkingArea |
getWorkingArea()
Gets the parent of this dockable, this should be the same as set by the last call of setWorkingArea(CWorkingArea) . |
CommonDockable |
intern()
Gets the intern representation of this dockable. |
boolean |
isCloseable()
Tells whether this dockable can be closed by the user. |
boolean |
isExternalizable()
Tells whether this dockable can be externalized by the user. |
boolean |
isMaximizable()
Tells whether this dockable can be maximized by the user. |
boolean |
isMinimizable()
Tells whether this dockable can be minimized by the user. |
boolean |
isStackable()
Tells whether this dockable can be combined with another dockable to create a stack. |
boolean |
isVisible()
Tells whether this dockable is currently visible or not. |
void |
removeCDockableListener(CDockableListener listener)
Removes a listener from this dockable. |
void |
setControl(CControlAccess control)
Sets the CControl which is responsible for this dockable. |
void |
setExtendedMode(CDockable.ExtendedMode extendedMode)
Sets how and where this dockable should be shown. |
void |
setLocation(CLocation location)
Sets the location of this dockable. |
void |
setVisible(boolean visible)
Shows or hides this dockable. |
void |
setWorkingArea(CWorkingArea area)
Sets the parent of this dockable. |
Method Detail |
---|
void addCDockableListener(CDockableListener listener)
listener
- the new listenervoid removeCDockableListener(CDockableListener listener)
listener
- the listener to removeboolean isMinimizable()
true
if this element can be minimizedboolean isMaximizable()
true
if this element can be maximizedboolean isExternalizable()
true
if this element can be externalizedboolean isStackable()
true
if this element can be combined with
another dockable, normally true
should be the answer.boolean isCloseable()
true
if this element can be closedvoid setVisible(boolean visible)
CControlAccess.show(CDockable)
or
CControlAccess.hide(CDockable)
.
visible
- the new visibility state
IllegalStateException
- if this dockable can't be made visibleisVisible()
boolean isVisible()
JFrame
is not shown, or some DockStation
not
properly added to a parent component, then a visible dockable can
be invisible for the user.CControlAccess.isVisible(CDockable)
.
true
if this dockable can be accessed by the user
through a graphical user interface.void setLocation(CLocation location)
location
- the new location, null
is possible, but
will not move the dockable immediatelyCLocation getLocation()
setLocation(CLocation)
.
null
void setExtendedMode(CDockable.ExtendedMode extendedMode)
isExternalizable()
, isMaximizable()
and isMinimizable()
will just be ignored.
extendedMode
- the size and locationCDockable.ExtendedMode getExtendedMode()
null
if this dockable
is not part of an CControl
.void setWorkingArea(CWorkingArea area)
setLocation(CLocation)
.
area
- the new parent or null
CWorkingArea getWorkingArea()
setWorkingArea(CWorkingArea)
.
null
CommonDockable intern()
void setControl(CControlAccess control)
CControl
which is responsible for this dockable. Subclasses
must call CControlAccess.link(CDockable, CDockableAccess)
to grant
the CControl
access to the internal systems of this
CDockable
. link
can also be used to revoke access.
control
- the new control or null
DockActionSource getClose()
CControlAccess getControl()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |