com.javadocking.component
Class DefaultDockHeader

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.javadocking.component.DefaultDockHeader

All Implemented Interfaces:

DockHeader, Header, DragHandle, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class DefaultDockHeader
extends javax.swing.JPanel
implements DockHeader

The default header for dragging all the dockables that are docked in a given dock.

The dockables can be dragged by dragging this component.

Author:

Heidi Rakels.

See Also:

Serialized Form

Nested Class Summary

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.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

DefaultDockHeader(LeafDock dock, int position)
Constructs a header for the given dock.

Method Summary

void	dispose() Disposes the header.
static java.awt.Color	getColor() Gets the color of the handle.
LeafDock	getDock() Gets the dock of this header.
DragListener	getDragListener() Gets the drag listener that will drag the dockables attached to this handle.
int	getPosition() Gets the position of this header.
static java.awt.Color	getShadow() Gets the color of the shadow of the handle.
void	paint(java.awt.Graphics graphics)
static void	setColor(java.awt.Color color) Sets the color of the handle.
void	setDragListener(DragListener dragListener) Sets the drag listener as mouse listener and mouse motion listener on the handle.
void	setPosition(int position) Gets the position of this header.
static void	setShadow(java.awt.Color shadow) Sets the color of the shadow of the handle.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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

Methods inherited from interface com.javadocking.component.Header

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

DefaultDockHeader

public DefaultDockHeader(LeafDock dock,
                         int position)

Constructs a header for the given dock.

Parameters:

dock - The dock of the header.

position - The position of this header. Possible values are constants defined by the class Position, i.e.:

• Position.LEFT,
• Position.RIGHT,
• Position.TOP,
• Position.BOTTOM.

Method Detail

setDragListener

public void setDragListener(DragListener dragListener)

Description copied from interface: DragHandle

Sets the drag listener as mouse listener and mouse motion listener on the handle.

Specified by:

setDragListener in interface DragHandle

Parameters:

dragListener - The drag listener that will drag the dockables attached to this handle.

getDragListener

public DragListener getDragListener()

Description copied from interface: DragHandle

Gets the drag listener that will drag the dockables attached to this handle.

Specified by:

getDragListener in interface DragHandle

Returns:

The drag listener that drags the dockables attached to this handle.

dispose

public void dispose()

Description copied from interface: Header

Disposes the header.

Specified by:

dispose in interface Header

getDock

public LeafDock getDock()

Description copied from interface: DockHeader

Gets the dock of this header.

Specified by:

getDock in interface DockHeader

Returns:

The dock of this header.

getPosition

public int getPosition()

Description copied from interface: Header

Gets the position of this header. Possible values are constants defined by the class Position, i.e.:

• Position.LEFT,
• Position.RIGHT,
• Position.TOP,
• Position.BOTTOM.

Specified by:

getPosition in interface Header

Returns:

The position of this header.

setPosition

public void setPosition(int position)

Description copied from interface: Header

Gets the position of this header. Possible values are constants defined by the class Position, i.e.:

• Position.LEFT,
• Position.RIGHT,
• Position.TOP,
• Position.BOTTOM.

Specified by:

setPosition in interface Header

Parameters:

position - The position of this header.

paint

public void paint(java.awt.Graphics graphics)

Overrides:

paint in class javax.swing.JComponent

getShadow

public static java.awt.Color getShadow()

Gets the color of the shadow of the handle.

Returns:

The color of the shadow of the handle.

setShadow

public static void setShadow(java.awt.Color shadow)

Sets the color of the shadow of the handle.

Parameters:

shadow - The color of the shadow of the handle.

getColor

public static java.awt.Color getColor()

Gets the color of the handle.

Returns:

The color of the handle.

setColor

public static void setColor(java.awt.Color color)

Sets the color of the handle.

Parameters:

color - The color of the handle.