|
||||||||||
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
@Todo(priority=MINOR, compatibility=COMPATIBLE, target=VERSION_1_1_0, description="Introduce some interface \'MultiCStation\' or similar: a set of CStations, CContentArea would implement this interface") 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.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary |
---|
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 |
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 . |
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. |
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. |
FlapDockStation |
getEast()
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. |
FlapDockStation |
getNorth()
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 |
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<?>[] |
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 |
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. |
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 |
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 |
---|
public String getUniqueId()
public CControl getControl()
CControl
for which this content area was created.
public CStation<?>[] getStations()
CContentArea
.
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 FlapDockStation getNorth()
CContentArea
public FlapDockStation getSouth()
CContentArea
public FlapDockStation getEast()
CContentArea
public FlapDockStation getWest()
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
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |