|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.JPanel bibliothek.gui.dock.common.CContentArea
public class CContentArea
A component that is normally set into the center of the
main- JFrame
. This component can display
and manage some CDockable
s.
This component contains in the center a SplitDockStation
allowing
to show several CDockable
s at the same time. At each border a
FlapDockStation
allows to show "minimized" CDockable
s.
Note: clients should not create CContentArea
s directly, they should
use CControl.getContentArea()
to get the default content area, or
CControl.createContentArea(String)
to create a new content area.
Nested Class Summary | |
---|---|
static class |
CContentArea.Corner
References a corner of a panel. |
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
static Path |
TYPE_ID_CENTER
The result of CStation.getTypeId() for the center station |
static Path |
TYPE_ID_MINIMIZE
The result of CStation.getTypeId() for the minimize stations |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
CContentArea(CControl control,
String uniqueId)
Creates a new content area. |
Method Summary | |
---|---|
void |
addStationContainerListener(CStationContainerListener listener)
Adds the observer listener to this container. |
protected void |
addStations(CStation<?>... stations)
Adds additional stations to the array of CStation . |
void |
deploy(CGrid grid)
Exchanges all the CDockable s on the center panel by
the elements of grid . |
SplitDockStation |
getCenter()
Gets the station in the center of this CContentArea . |
CGridArea |
getCenterArea()
Gets the station in the center of this CContentArea . |
String |
getCenterIdentifier()
Gets the global identifier for the panel in the center. |
static String |
getCenterIdentifier(String uniqueCenterId)
Creates the global identifier of a panel in the center. |
Component |
getComponent()
Gets a Component whose children are all the CStation s of this
CStationContainer . |
CControl |
getControl()
Gets the CControl for which this content area was created. |
Component |
getCornerComponent(CContentArea.Corner corner,
boolean horizontal)
Gets the component of a corner. |
CStation<?> |
getDefaultStation()
Gets the preferred default CStation of this container. |
CStation<?> |
getDefaultStation(ExtendedMode mode)
Gets the preferred default CStation of this container for children in mode mode . |
FlapDockStation |
getEast()
Gets the station in the east of this CContentArea |
CMinimizeArea |
getEastArea()
Gets the station in the east of this CContentArea |
String |
getEastIdentifier()
Gets the global identifier for the panel in the east. |
static String |
getEastIdentifier(String uniqueCenterId)
Creates the global identifier of a panel in the east. |
CStation<?> |
getMatchingStation(CStationContainer container,
CStation<?> station)
Assuming container is a type of CStationContainer that is known to
this , and assuming station is a child of container : this
method returns one of this children that has the same relative location in respect to this
as station has to container . |
FlapDockStation |
getNorth()
Gets the station in the north of this CContentArea |
CMinimizeArea |
getNorthArea()
Gets the station in the north of this CContentArea |
String |
getNorthIdentifier()
Gets the global identifier for the panel in the north. |
static String |
getNorthIdentifier(String uniqueCenterId)
Creates the global identifier of a panel in the north. |
FlapDockStation |
getSouth()
Gets the station in the south of this CContentArea |
CMinimizeArea |
getSouthArea()
Gets the station in the south of this CContentArea |
String |
getSouthIdentifier()
Gets the global identifier for the panel in the south. |
static String |
getSouthIdentifier(String uniqueCenterId)
Creates the global identifier of a panel in the south. |
CStation<?> |
getStation(int index)
Gets the index'th child of this container. |
int |
getStationCount()
Gets the number of CStation s that are currently in this container. |
CStation<?>[] |
getStations()
Gets an independant array of all stations that are used on this CContentArea . |
String |
getUniqueId()
Gets the unique id of this center. |
FlapDockStation |
getWest()
Gets the station in the west of this CContentArea |
CMinimizeArea |
getWestArea()
Gets the station in the west of this CContentArea |
String |
getWestIdentifier()
Gets the global identifier for the panel in the west. |
static String |
getWestIdentifier(String uniqueCenterId)
Creates the global identifier of a panel in the west. |
int |
indexOf(CStation<?> child)
Gets the index of child . |
void |
removeStationContainerListener(CStationContainerListener listener)
Removes the observer listener from this container. |
void |
setCornerComponent(Component component,
CContentArea.Corner corner,
boolean horizontal)
Puts component in one corner of this area. |
void |
setMinimumAreaSize(Dimension size)
Sets the minimum size of the four areas in which minimized Dockable s
are shown. |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
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_CENTER
CStation.getTypeId()
for the center station
public static final Path TYPE_ID_MINIMIZE
CStation.getTypeId()
for the minimize stations
Constructor Detail |
---|
public CContentArea(CControl control, String uniqueId)
control
- the control for which this area will be useduniqueId
- a unique identifier of this centerMethod Detail |
---|
protected void addStations(CStation<?>... stations)
array
of CStation
. This method
should only be called by subclasses.
stations
- the additional stations to storepublic String getUniqueId()
getUniqueId
in interface CStationContainer
public Component getComponent()
CStationContainer
Component
whose children are all the CStation
s of this
CStationContainer
.
getComponent
in interface CStationContainer
CStation
s, not null
public void addStationContainerListener(CStationContainerListener listener)
CStationContainer
listener
to this container. The listener is to be informed
whenever a CStation
is added or removed from this container.
addStationContainerListener
in interface CStationContainer
listener
- the new listener, not null
public void removeStationContainerListener(CStationContainerListener listener)
CStationContainer
listener
from this container.
removeStationContainerListener
in interface CStationContainer
listener
- the listener to removepublic CControl getControl()
CControl
for which this content area was created.
public CStation<?>[] getStations()
CContentArea
.
public int getStationCount()
CStationContainer
CStation
s that are currently in this container.
getStationCount
in interface CStationContainer
public CStation<?> getStation(int index)
CStationContainer
getStation
in interface CStationContainer
index
- the index of the child, between 0 and CStationContainer.getStationCount()
null
public int indexOf(CStation<?> child)
child
.
child
- a child CStation
of this area.
child
or -1 if not foundpublic CStation<?> getDefaultStation()
CStationContainer
CStation
of this container. Children with no location
are usually made visible on such a default station.
getDefaultStation
in interface CStationContainer
null
public CStation<?> getDefaultStation(ExtendedMode mode)
CStationContainer
CStation
of this container for children in mode mode
.
getDefaultStation
in interface CStationContainer
mode
- the mode for which a station is searched
CStationContainer
that can show Dockable
s in mode mode
,
can be null
public void deploy(CGrid grid)
CDockable
s on the center panel by
the elements of grid
.
grid
- a grid containing some new Dockable
spublic void setCornerComponent(Component component, CContentArea.Corner corner, boolean horizontal)
component
in one corner of this area.
component
- the component, can be null
corner
- the corner into which to put component
horizontal
- whether component
should be horizontally
or vertically.public Component getCornerComponent(CContentArea.Corner corner, boolean horizontal)
corner
- the corner in which to searchhorizontal
- whether the component is horizontally or vertically
null
public void setMinimumAreaSize(Dimension size)
Dockable
s
are shown. Clients could also call get'Side'().setMinimumSize( size )
.getMinimumAreaSize
because the result might
not be the same for all stations.
size
- the new minimum size or null
to revert to the default
value.FlapDockStation.setMinimumSize(Dimension)
,
FlapDockStation.MINIMUM_SIZE
public SplitDockStation getCenter()
CContentArea
.
public CGridArea getCenterArea()
CContentArea
.
public FlapDockStation getNorth()
CContentArea
public CMinimizeArea getNorthArea()
CContentArea
public FlapDockStation getSouth()
CContentArea
public CMinimizeArea getSouthArea()
CContentArea
public FlapDockStation getEast()
CContentArea
public CMinimizeArea getEastArea()
CContentArea
public FlapDockStation getWest()
CContentArea
public CMinimizeArea getWestArea()
CContentArea
public String getCenterIdentifier()
public static String getCenterIdentifier(String uniqueCenterId)
uniqueCenterId
- the unique if of the owning CContentArea
.
public String getNorthIdentifier()
public static String getNorthIdentifier(String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public String getSouthIdentifier()
public static String getSouthIdentifier(String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public String getEastIdentifier()
public static String getEastIdentifier(String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public String getWestIdentifier()
public static String getWestIdentifier(String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public CStation<?> getMatchingStation(CStationContainer container, CStation<?> station)
CStationContainer
container
is a type of CStationContainer
that is known to
this
, and assuming station
is a child of container
: this
method returns one of this
children that has the same relative location in respect to this
as station
has to container
. For example if station
is the
center area of a CGridArea
, and this
is a CGridArea
as well, then
this method would return the center area of this
.
getMatchingStation
in interface CStationContainer
container
- some kind of CStationContainer
, may be a type that is known to this
or not.station
- some child of container
this
, such that the location of the child in relation to this
is
equivalent to the location of station
in relation to container
. A value of
null
indicates that this method did not find a suitable child. If possible the result of this method
and station
should be of the same type.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |