|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.common.intern.AbstractCDockable bibliothek.gui.dock.common.intern.AbstractDockableCStation<CSplitDockStation> bibliothek.gui.dock.common.CGridArea
public class CGridArea
In a CGridArea
normalized CDockable
can be shown. Clients
should use getComponent()
to gain access to a JComponent
that
represents this area.
Field Summary | |
---|---|
static Path |
TYPE_ID
The result of getTypeId() |
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_MINIMIZE_HOLD, ACTION_KEY_NORMALIZE, ACTION_KEY_UNEXTERNALIZE, ACTION_KEY_UNMAXIMIZE_EXTERNALIZED |
Constructor Summary | |
---|---|
protected |
CGridArea()
Creates a new grid area but does not yet initialize its fields. |
|
CGridArea(CControl control,
String uniqueId)
Creates a new area. |
Method Summary | |
---|---|
CDockable |
asDockable()
If this station is a CDockable as well, then this method returns
the representation of this station as CDockable . |
protected CommonDockable |
createCommonDockable()
Creates the CommonDockable that is associated with this dockable, called the first
time the CommonDockable is required for an operation. |
CStationPerspective |
createPerspective()
Returns a new CStationPerspective that represents this station. |
void |
deploy(CGrid grid)
Exchanges all the CDockable s on this area with the
elements of grid . |
JComponent |
getComponent()
Gets the JComponent which represents this station. |
CSplitDockStation |
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. |
Path |
getTypeId()
Gets a unique path denoting the type of this station. |
String |
getUniqueId()
Gets a unique and constant identifier for this station |
protected void |
init(CControl control,
String uniqueId)
Initializes the fields of this area. |
protected void |
install(CControlAccess access)
Called when this station is added to a CControl . |
boolean |
isCloseable()
Tells whether this CDockable can be closed by the user. |
boolean |
isExternalizable()
Tells whether this CDockable can be externalized by the user. |
boolean |
isMaximizable()
Tells whether this CDockable can be maximized by the user. |
boolean |
isMaximizingArea()
Tells whether children of this area remain children when maximized or not. |
boolean |
isMinimizable()
Tells whether this CDockable can be minimized by the user. |
boolean |
isStackable()
Tells whether this CDockable can be combined with another
Dockable to create a stack. |
boolean |
isWorkingArea()
Tells whether this station is a special working area or not. |
void |
setMaximizingArea(boolean maximize)
Sets whether this area is also used as maximizing area. |
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. |
protected void |
uninstall(CControlAccess access)
Called when this station is removed from a CControl . |
Methods inherited from class bibliothek.gui.dock.common.intern.AbstractDockableCStation |
---|
asStation, getDropLocation, init, setControlAccess, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Path TYPE_ID
getTypeId()
Constructor Detail |
---|
public CGridArea(CControl control, String uniqueId)
control
- the owner of this stationuniqueId
- a unique identifierprotected CGridArea()
init(CControl, String)
to complete
initialization
Method Detail |
---|
protected void init(CControl control, String uniqueId)
control
- the owner of this stationuniqueId
- a unique identifierprotected CommonDockable createCommonDockable()
AbstractCDockable
CommonDockable
that is associated with this dockable, called the first
time the CommonDockable
is required for an operation.
createCommonDockable
in class AbstractDockableCStation<CSplitDockStation>
public void deploy(CGrid grid)
CDockable
s on this area with the
elements of grid
.
grid
- a grid containing some new Dockable
spublic CSplitDockStation getStation()
CStation
CStation
.
getStation
in interface CStation<CSplitDockStation>
getStation
in class AbstractDockableCStation<CSplitDockStation>
public CDockable asDockable()
CStation
CDockable
as well, then this method returns
the representation of this station as CDockable
.
asDockable
in interface CStation<CSplitDockStation>
asDockable
in class AbstractDockableCStation<CSplitDockStation>
null
public CStationPerspective createPerspective()
CStation
CStationPerspective
that represents this
station. This method
does not need to set any content of the new perspective. Basically this method just needs to tell
the framework what type of CStationPerspective
is needed, not what its content is.
createPerspective
in interface CStation<CSplitDockStation>
CStation.getTypeId()
public JComponent getComponent()
JComponent
which represents this station.
public CLocation getStationLocation()
CStation
CStation.getStation()
.
getStationLocation
in interface CStation<CSplitDockStation>
getStationLocation
in class AbstractDockableCStation<CSplitDockStation>
station
public Path getTypeId()
CStation
MissingPerspectiveStrategy.createStation(String, Path)
when loading a layout
as a CPerspective
.
getTypeId
in interface CStation<CSplitDockStation>
null
will just be ignored.public void setTitleText(String text)
text
- the titlepublic String getTitleText()
public void setTitleIcon(Icon icon)
CDockable
.
icon
- the title-iconpublic Icon getTitleIcon()
null
public void setMaximizingArea(boolean maximize)
maximize
- true
if children should be maximized to this
area, false
if not.public boolean isMaximizingArea()
true
if children remain childrensetMaximizingArea(boolean)
protected void install(CControlAccess access)
AbstractDockableCStation
CControl
.
install
in class AbstractDockableCStation<CSplitDockStation>
access
- access to the internals of the new ownerprotected void uninstall(CControlAccess access)
AbstractDockableCStation
CControl
.
uninstall
in class AbstractDockableCStation<CSplitDockStation>
access
- access to the internals of the old ownerpublic boolean isCloseable()
CDockable
CDockable
can be closed by the user. A close-button
has to be provided by the CDockable
itself. The best way to do that is
to instantiate a CloseActionSource
and include this source
in the array that is returned by CommonDockable.getSources()
.
isCloseable
in interface CDockable
true
if this element can be closedpublic String getUniqueId()
CStation
getUniqueId
in interface CStation<CSplitDockStation>
getUniqueId
in interface SingleCDockable
getUniqueId
in class AbstractDockableCStation<CSplitDockStation>
public boolean isExternalizable()
CDockable
CDockable
can be externalized by the user.
isExternalizable
in interface CDockable
true
if this element can be externalizedpublic boolean isMaximizable()
CDockable
CDockable
can be maximized by the user.
isMaximizable
in interface CDockable
true
if this element can be maximizedpublic boolean isMinimizable()
CDockable
CDockable
can be minimized by the user.
isMinimizable
in interface CDockable
true
if this element can be minimizedpublic boolean isStackable()
CDockable
CDockable
can be combined with another
Dockable
to create a stack.
isStackable
in interface CDockable
true
if this element can be combined with
another Dockable
, normally true
should be the answer.public boolean isWorkingArea()
CStation
CControl.addStation(CStation, boolean)
)
or must be a SingleCDockable
.
isWorkingArea
in interface CStation<CSplitDockStation>
isWorkingArea
in class AbstractDockableCStation<CSplitDockStation>
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 |