|
||||||||||
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 |
addCDockablePropertyListener(CDockablePropertyListener listener)
Adds a property listener to this dockable, the listener will be informed of changes of this dockable. |
void |
addCDockableStateListener(CDockableStateListener listener)
Adds a state listener to this dockable, the listener will be informed of changes of this dockable. |
Dimension |
getAndClearResizeRequest()
Gets the preferred size of this CDockable . |
DockActionSource |
getClose()
Gets the source that contains the close-action. |
ColorMap |
getColors()
Gets a mutable map of colors. |
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. |
Dimension |
getMinimizedSize()
Gets the size which is used when this dockable is minimzed and on a popup window. |
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 |
isMinimizedHold()
Tells whether this dockable remains visible when minimized and without focus. |
boolean |
isResizeLocked()
Tells whether the size of this dockable should remain the same when its parent changes the size. |
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 |
removeCDockablePropertyListener(CDockablePropertyListener listener)
Removes a property listener from this dockable. |
void |
removeCDockableStateListener(CDockableStateListener listener)
Removes a state 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 |
setMinimizedHold(boolean hold)
Sets whether this dockable should remain visible when minimized and without focus. |
void |
setMinimizedSize(Dimension size)
Sets the size of this dockable when this dockable is minimized and on a popup window. |
void |
setVisible(boolean visible)
Shows or hides this dockable. |
void |
setWorkingArea(CWorkingArea area)
Sets the parent of this dockable. |
Method Detail |
---|
void addCDockableStateListener(CDockableStateListener listener)
listener
- the new listenervoid addCDockablePropertyListener(CDockablePropertyListener listener)
listener
- the new listenervoid removeCDockableStateListener(CDockableStateListener listener)
listener
- the listener to removevoid removeCDockablePropertyListener(CDockablePropertyListener 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 closedboolean isResizeLocked()
true
if the size of this dockable should remain
the same during resize events of the parent.Dimension getAndClearResizeRequest()
CDockable
. The preferred size
will be used to resize this CDockable
when
CControl.handleResizeRequests()
is called. There are no guarantees
that the request can be granted, or will be handled at all.null
is
returned.
null
void 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
void setMinimizedSize(Dimension size)
size
- the sizeDimension getMinimizedSize()
void setMinimizedHold(boolean hold)
hold
- whether to remain visibleboolean isMinimizedHold()
true
if this remains visible, false
otherwiseCommonDockable 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()
ColorMap getColors()
CControlAccess getControl()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |