Package bibliothek.gui.dock.common

Class CMinimizeArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

bibliothek.gui.dock.common.CMinimizeArea

All Implemented Interfaces:

CStation<CFlapDockStation>, ImageObserver, MenuContainer, Serializable, Accessible

public class CMinimizeArea
extends JPanel
implements CStation<CFlapDockStation>

An area where CDockables can be stored in their minimized state. This class is a subclass of JPanel and can be added anywhere in any frame or dialog. This JPanel uses a BorderLayout and clients may add additional Components to it, the Components the size and location of the opening window will always depend on this JPanel.

Author:

Benjamin Sigg

See Also:

• Serialized Form

Nested Class Summary

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

Fields

Modifier and Type	Field	Description
static final Path	TYPE_ID	The result of getTypeId()

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Modifier	Constructor	Description
protected	CMinimizeArea()	Default constructor doing nothing, subclasses must call init(CControl, String) after calling this method
	CMinimizeArea(CControl control, String uniqueId)	Creates a new minimize area.

Method Summary

Modifier and Type	Method	Description
CDockable	asDockable()	If this station is a CDockable as well, then this method returns the representation of this station as CDockable.
CStationPerspective	createPerspective()	Returns a new CStationPerspective that represents this station.
CLocation	getDropLocation()	Creates a CLocation that can be used to drop a new CDockable on this station or one of its children stations.
CFlapDockStation	getStation()	Gets the internal representation of this CStation.
CLocation	getStationLocation()	Gets a location which represents directly CStation.getStation().
Path	getTypeId()	Gets a unique path denoting the type of this station.
String	getUniqueId()	Gets the unique uniqueId of this area.
protected void	init(CControl control, String uniqueId)	Initializes the new area, should be called only once by subclasses
boolean	isWorkingArea()	Tells whether this station is a special working area or not.
void	setControlAccess(CControlAccess access)	Called by CControl when this CStation is added or removed.
void	setDirection(FlapDockStation.Direction direction)	Sets the direction into which the tab opens.

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, getBaseline, getBaselineResizeBehavior, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TYPE_ID

public static final Path TYPE_ID

The result of getTypeId()

Constructor Details

CMinimizeArea

public CMinimizeArea(CControl control,
 String uniqueId)

Creates a new minimize area.

Parameters:

control - the control for which this area will be used

uniqueId - the unique uniqueId of this area

CMinimizeArea

protected CMinimizeArea()

Default constructor doing nothing, subclasses must call init(CControl, String) after calling this method

Method Details

init

protected void init(CControl control,
 String uniqueId)

Initializes the new area, should be called only once by subclasses

Parameters:

control - the control for which this area will be used

uniqueId - the unique uniqueId of this area

setControlAccess

public void setControlAccess(CControlAccess access)

Description copied from interface: CStation

Called by CControl when this CStation is added or removed. There are two actions which most stations might want to do:

• Call one of the add methods for ModeAreas accessible through the CLocationModeManager. That will ensure that the station can be used as minimize/normalize/... area.
• Add a ResizeRequestListener to CControl in order to be informed when resize requests are to be handled.

Specified by:

setControlAccess in interface CStation<CFlapDockStation>

Parameters:

access - access to the internals of the CControl that uses this station or null to remove all ties from a control

getUniqueId

public String getUniqueId()

Gets the unique uniqueId of this area.

Specified by:

getUniqueId in interface CStation<CFlapDockStation>

Returns:

the unique uniqueId

getTypeId

public Path getTypeId()

Description copied from interface: CStation

Gets a unique path denoting the type of this station. This path will be given to MissingPerspectiveStrategy.createStation(String, Path) when loading a layout as a CPerspective.

Specified by:

getTypeId in interface CStation<CFlapDockStation>

Returns:

the type of this station. Paths starting with "dock." are reserved for the framework. A value of null will just be ignored.

getStation

public CFlapDockStation getStation()

Description copied from interface: CStation

Gets the internal representation of this CStation.

Specified by:

getStation in interface CStation<CFlapDockStation>

Returns:

the internal representation

createPerspective

public CStationPerspective createPerspective()

Description copied from interface: CStation

Returns a new 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.

Specified by:

createPerspective in interface CStation<CFlapDockStation>

Returns:

the new, empty perspective

See Also:

• CStation.getTypeId()

getStationLocation

public CLocation getStationLocation()

Description copied from interface: CStation

Gets a location which represents directly CStation.getStation().

Specified by:

getStationLocation in interface CStation<CFlapDockStation>

Returns:

the location that will always represent the station

getDropLocation

public CLocation getDropLocation()

Description copied from interface: CStation

Creates a CLocation that can be used to drop a new CDockable on this station or one of its children stations. This method returns the "optimal spot", where the definition of "optimal spot" is up to the station itself. The default implementations however call CLocationModeManager.getDropLocation(CStation).

Specified by:

getDropLocation in interface CStation<CFlapDockStation>

Returns:

the optimal spot for dropping a new CDockable or null if this station is not able to calculate the optimal spot (e.g. because the station is not visible)

See Also:

• CDockable.setLocationsAside(CDockable)
• CDockable.setLocationsAsideFocused()

isWorkingArea

public boolean isWorkingArea()

Description copied from interface: CStation

Tells whether this station is a special working area or not. It is not possible drag a child from a working area if it is registered there, or to drop a child onto a working area if it is not registered there.
Working areas must either be registered as root-station (see CControl.addStation(CStation, boolean)) or must be a SingleCDockable.

Specified by:

isWorkingArea in interface CStation<CFlapDockStation>

Returns:

true if this is a working area, false otherwise

asDockable

public CDockable asDockable()

Description copied from interface: CStation

If this station is a CDockable as well, then this method returns the representation of this station as CDockable.

Specified by:

asDockable in interface CStation<CFlapDockStation>

Returns:

this as dockable or null

setDirection

public void setDirection(FlapDockStation.Direction direction)

Sets the direction into which the tab opens.

Parameters:

direction - the direction or null to let the system decide automatically