|
||||||||||
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_1, 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 |
---|
javax.swing.JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
javax.swing.JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
java.awt.Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.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,
java.lang.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 . |
CGridArea |
getCenterArea()
Gets the station in the center of this CContentArea . |
java.lang.String |
getCenterIdentifier()
Gets the global identifier for the panel in the center. |
static java.lang.String |
getCenterIdentifier(java.lang.String uniqueCenterId)
Creates the global identifier of a panel in the center. |
CControl |
getControl()
Gets the CControl for which this content area was created. |
java.awt.Component |
getCornerComponent(CContentArea.Corner corner,
boolean horizontal)
Gets the component of a corner. |
FlapDockStation |
getEast()
Gets the station in the east of this CContentArea |
CMinimizeArea |
getEastArea()
Gets the station in the east of this CContentArea |
java.lang.String |
getEastIdentifier()
Gets the global identifier for the panel in the east. |
static java.lang.String |
getEastIdentifier(java.lang.String uniqueCenterId)
Creates the global identifier of a panel in the east. |
FlapDockStation |
getNorth()
Gets the station in the north of this CContentArea |
CMinimizeArea |
getNorthArea()
Gets the station in the north of this CContentArea |
java.lang.String |
getNorthIdentifier()
Gets the global identifier for the panel in the north. |
static java.lang.String |
getNorthIdentifier(java.lang.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 |
java.lang.String |
getSouthIdentifier()
Gets the global identifier for the panel in the south. |
static java.lang.String |
getSouthIdentifier(java.lang.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 . |
java.lang.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 |
java.lang.String |
getWestIdentifier()
Gets the global identifier for the panel in the west. |
static java.lang.String |
getWestIdentifier(java.lang.String uniqueCenterId)
Creates the global identifier of a panel in the west. |
void |
setCornerComponent(java.awt.Component component,
CContentArea.Corner corner,
boolean horizontal)
Puts component in one corner of this area. |
void |
setMinimumAreaSize(java.awt.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 javax.swing.JComponent |
---|
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
---|
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
Methods inherited from class java.awt.Component |
---|
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
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, java.lang.String uniqueId)
control
- the control for which this area will be useduniqueId
- a unique identifier of this centerMethod Detail |
---|
public java.lang.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(java.awt.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 java.awt.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(java.awt.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 java.lang.String getCenterIdentifier()
public static java.lang.String getCenterIdentifier(java.lang.String uniqueCenterId)
uniqueCenterId
- the unique if of the owning CContentArea
.
public java.lang.String getNorthIdentifier()
public static java.lang.String getNorthIdentifier(java.lang.String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public java.lang.String getSouthIdentifier()
public static java.lang.String getSouthIdentifier(java.lang.String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public java.lang.String getEastIdentifier()
public static java.lang.String getEastIdentifier(java.lang.String uniqueCenterId)
uniqueCenterId
- the unique id of the owning CContentArea
.
public java.lang.String getWestIdentifier()
public static java.lang.String getWestIdentifier(java.lang.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 |