|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbibliothek.gui.dock.common.intern.AbstractCDockable
bibliothek.gui.dock.common.CWorkingArea
public class CWorkingArea
A working area is an element which is always visible and contains some
CDockable
s which can't be dragged out of it. Also no CDockable
can be dropped in a CWorkingArea
.
There can be more than one CWorkingArea
, and the working areas
can be nested.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface bibliothek.gui.dock.common.intern.CDockable |
---|
CDockable.ExtendedMode |
Field Summary |
---|
Fields inherited from class bibliothek.gui.dock.common.intern.AbstractCDockable |
---|
listenerCollection |
Fields inherited from interface bibliothek.gui.dock.common.intern.CDockable |
---|
ACTION_KEY_CLOSE, ACTION_KEY_EXTERNALIZE, ACTION_KEY_MAXIMIZE, ACTION_KEY_MINIMIZE, ACTION_KEY_NORMALIZE |
Constructor Summary | |
---|---|
CWorkingArea(String uniqueId,
boolean restrictedEnvironment)
Creates a new area. |
Method Summary | ||
---|---|---|
|
add(F dockable)
Ensures that this is the parent of dockable
and adds dockable to the CControl which is associated
with this CWorkingArea . |
|
|
add(F dockable)
Ensures that this is the parent of dockable
and adds dockable to the CControl which is associated
with this CWorkingArea . |
|
CDockable |
asDockable()
If this station is a CDockable as well, then this method returns
the representation of this station as CDockable . |
|
void |
deploy(CGrid grid)
Exchanges all the CDockable s on this area with the
elements of grid . |
|
DockStation |
getStation()
Gets the internal representation of this CStation . |
|
CLocation |
getStationLocation()
Gets a location which represents directly CStation.getStation() . |
|
Icon |
getTitleIcon()
Gets the icon that is shown in the title. |
|
String |
getTitleText()
Gets the text that is shown as title. |
|
String |
getUniqueId()
Gets a unique and constant identifier for this station |
|
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 |
isSuppressTitle()
Deprecated. use AbstractCDockable.isTitleShown() instead |
|
boolean |
isWorkingArea()
Tells whether this station is a special working area or not. |
|
void |
setControl(CControlAccess control)
Sets the CControl which is responsible for this dockable. |
|
void |
setSuppressTitle(boolean suppressTitle)
Deprecated. use AbstractCDockable.setTitleShown(boolean) instead |
|
void |
setTitleIcon(Icon icon)
Sets the icon that is shown in the title of this CDockable . |
|
void |
setTitleText(String text)
Sets the text that is shown as title. |
|
protected boolean |
suppressTitle(DockTitleVersion version)
Checks whether the title created by version should
be suppressed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CWorkingArea(String uniqueId, boolean restrictedEnvironment)
uniqueId
- a unique identifierrestrictedEnvironment
- true
if the SecurityManager
is active, for example in an applet or when using webstart.Method Detail |
---|
public void deploy(CGrid grid)
CDockable
s on this area with the
elements of grid
. This method also calls
CDockable.setWorkingArea(CStation)
for each
dockable in grid
.
grid
- a grid containing some new Dockable
spublic DockStation getStation()
CStation
CStation
.
getStation
in interface CStation
public CDockable asDockable()
CStation
CDockable
as well, then this method returns
the representation of this station as CDockable
.
asDockable
in interface CStation
null
public CLocation getStationLocation()
CStation
CStation.getStation()
.
getStationLocation
in interface CStation
station
@Deprecated public void setSuppressTitle(boolean suppressTitle)
AbstractCDockable.setTitleShown(boolean)
instead
suppressTitle
- true
if this area should try
not to have a title.@Deprecated public boolean isSuppressTitle()
AbstractCDockable.isTitleShown()
instead
true
if this area normally has no titlepublic void setTitleText(String text)
text
- the titlepublic String getTitleText()
public void setTitleIcon(Icon icon)
CDockable
.
icon
- the title-iconpublic Icon getTitleIcon()
null
public <F extends SingleCDockable> F add(F dockable)
this
is the parent of dockable
and adds dockable
to the CControl
which is associated
with this CWorkingArea
. If there is no CControl
, then
the dockable
is added nowhere.
F
- the type of element to adddockable
- the new element
dockable
public <F extends MultipleCDockable> F add(F dockable)
this
is the parent of dockable
and adds dockable
to the CControl
which is associated
with this CWorkingArea
. If there is no CControl
, then
the dockable
is added nowhere.
F
- the type of element to adddockable
- the new element
dockable
public void setControl(CControlAccess control)
AbstractCDockable
CControl
which is responsible for this dockable.
setControl
in interface CStation
setControl
in interface CDockable
setControl
in class AbstractCDockable
control
- the new controlpublic boolean isCloseable()
CDockable
isCloseable
in interface CDockable
true
if this element can be closedpublic String getUniqueId()
CStation
getUniqueId
in interface CStation
getUniqueId
in interface SingleCDockable
public boolean isExternalizable()
CDockable
isExternalizable
in interface CDockable
true
if this element can be externalizedpublic boolean isMaximizable()
CDockable
isMaximizable
in interface CDockable
true
if this element can be maximizedpublic boolean isMinimizable()
CDockable
isMinimizable
in interface CDockable
true
if this element can be minimizedpublic boolean isStackable()
CDockable
isStackable
in interface CDockable
true
if this element can be combined with
another dockable, normally true
should be the answer.public boolean isWorkingArea()
CStation
isWorkingArea
in interface CStation
true
if this is a working area, false
otherwiseprotected boolean suppressTitle(DockTitleVersion version)
version
should
be suppressed.
version
- the version of the title
true
if no DockTitle
should be created
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |