com.javadocking.component
Class MinimzeHeader

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by com.javadocking.component.SelectableDockableHeader
                      extended by com.javadocking.component.MinimzeHeader
All Implemented Interfaces:
Header, SelectableHeader, DraggableContent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MinimzeHeader
extends SelectableDockableHeader
implements DraggableContent

A header for a minimized dockable.

This header should be put in a dockable.The dockable can be dragged by dragging the header. The header can be dragged, if it is put in a dockable.

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
MinimzeHeader(Dockable dockable, int position)
           Constructs a header for a dockable that is minimized.
MinimzeHeader(Dockable dockable, int position, ShowActionMode showActionMode, ShowActionMode selectedShowActionMode)
           Constructs a header for a dockable that is docked in a tabbed pane.
 
Method Summary
 void addDragListener(DragListener dragListener)
          Adds the given drag listener as mouse listener and mouse motion listener on the content of this component.
 void addMouseListener(java.awt.event.MouseListener mouseListener)
           
protected  int calculatePreferredWidth()
          Calculates the preferred width of the components in the header.
 javax.swing.border.Border getDeselectedBorder()
          Gets the border, that is used when the haeder is not selected.
protected  int getHeaderHeight()
          Get the height of the header.
protected  int getHeaderMaximumWidth()
          Get the maximum width of the header.
 java.awt.Dimension getPreferredSize()
           
 javax.swing.border.Border getSelectedBorder()
          Gets the border, when the haeder is selected.
 void setDeselectedBorder(javax.swing.border.Border border)
          Sets the border, that is used when the haeder is not selected.
 void setSelected(boolean selected)
          Selects or deselects the header.
 void setSelectedBorder(javax.swing.border.Border selectedBorder)
          Sets the border, when the haeder is selected.
 
Methods inherited from class com.javadocking.component.SelectableDockableHeader
addPropertyChangeListener, dispose, getActionPanel, getIconLabel, getPosition, getSelectedActionPanel, getSelectedShowActionMode, getShowActionMode, getTitleLabel, isSelected, removePropertyChangeListener, setPosition, setSelectedShowActionMode, setShowActionMode
 
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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, 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
 

Constructor Detail

MinimzeHeader

public MinimzeHeader(Dockable dockable,
                     int position)

Constructs a header for a dockable that is minimized.

The title of the dockable is set in the header. The icon is displayed.

If there are actions, they are also displayed. The buttons for the actions are created with the method SwComponentFactory.createIconButton(Action). The component factory that is used is the component factory of the DockingManager.

No actions are shown when the header is not selected. All the dockable actions are shown when the header is selected.

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

MinimzeHeader

public MinimzeHeader(Dockable dockable,
                     int position,
                     ShowActionMode showActionMode,
                     ShowActionMode selectedShowActionMode)

Constructs a header for a dockable that is docked in a tabbed pane. This header has to be put in the tab.

The title of the dockable is set in the header. The icon is displayed.

If there are actions, they are also displayed. The buttons for the actions are created with the method SwComponentFactory.createIconButton(Action). The component factory that is used is the component factory of the DockingManager.

When the dockable is not selected, only the first row of actions of the dockable are shown. When the dockable is selected, all dockable actions are shown.

Parameters:
dockable - The dockable of the header.
position - The position of the header. Possible values are constants defined by the class Position, i.e.:
showActionMode - Defines which actions are shown in the header, when the header is not selected.
selectedShowActionMode - Defines which actions are shown in the header, when the header is selected.
Method Detail

addDragListener

public void addDragListener(DragListener dragListener)
Description copied from interface: DraggableContent
Adds the given drag listener as mouse listener and mouse motion listener on the content of this component.

Specified by:
addDragListener in interface DraggableContent
Parameters:
dragListener - The drag listener for dragging and docking the dockable with this component as content.

getDeselectedBorder

public javax.swing.border.Border getDeselectedBorder()
Gets the border, that is used when the haeder is not selected.

Returns:
The border, that is used when the haeder is not selected.

setDeselectedBorder

public void setDeselectedBorder(javax.swing.border.Border border)
Sets the border, that is used when the haeder is not selected.

Parameters:
border - The border, that is used when the haeder is not selected.

getSelectedBorder

public javax.swing.border.Border getSelectedBorder()
Gets the border, when the haeder is selected.

Returns:
The border, when the haeder is selected.

setSelectedBorder

public void setSelectedBorder(javax.swing.border.Border selectedBorder)
Sets the border, when the haeder is selected.

Parameters:
selectedBorder - The border, when the haeder is selected.

setSelected

public void setSelected(boolean selected)
Description copied from interface: SelectableHeader
Selects or deselects the header.

Specified by:
setSelected in interface SelectableHeader
Overrides:
setSelected in class SelectableDockableHeader
Parameters:
selected - True if the header has to be selected, false otherwise.

addMouseListener

public void addMouseListener(java.awt.event.MouseListener mouseListener)
Overrides:
addMouseListener in class java.awt.Component

getPreferredSize

public java.awt.Dimension getPreferredSize()
Overrides:
getPreferredSize in class SelectableDockableHeader

getHeaderHeight

protected int getHeaderHeight()
Get the height of the header.

Overrides:
getHeaderHeight in class SelectableDockableHeader
Returns:
The height of the header.

getHeaderMaximumWidth

protected int getHeaderMaximumWidth()
Get the maximum width of the header.

Overrides:
getHeaderMaximumWidth in class SelectableDockableHeader
Returns:
The maximum width of the header.

calculatePreferredWidth

protected int calculatePreferredWidth()
Description copied from class: SelectableDockableHeader
Calculates the preferred width of the components in the header.

Overrides:
calculatePreferredWidth in class SelectableDockableHeader
Returns:
The maximum width of the components in the header.