com.javadocking.component
Class SelectableDockableHeader

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MinimzeHeader

public class SelectableDockableHeader
extends javax.swing.JPanel
implements SelectableHeader

A header for a dockable that can be selected.

It contains:

a label with the title of the dockable. the icon of the dockable, if there is one. the buttons with the first array of actions of the dockable, if there are actions.

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

SelectableDockableHeader(Dockable dockable, int position)
Constructs a small header for a dockable that can be selected.

SelectableDockableHeader(Dockable dockable, int position, ShowActionMode showActionMode, ShowActionMode selectedShowActionMode)
Constructs a header for a dockable that can be selected.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Adds a java.beans.PropertyChangeListener.
protected int	calculatePreferredWidth() Calculates the preferred width of the components in the header.
protected javax.swing.JPanel	getActionPanel() Gets the panel with the actions.
protected int	getHeaderHeight() Get the height of the header.
protected int	getHeaderMaximumWidth() Get the maximum width of the header.
protected javax.swing.JLabel	getIconLabel() Gets the label with the icon.
int	getPosition() Gets the position of this header.
java.awt.Dimension	getPreferredSize()
javax.swing.JPanel	getSelectedActionPanel() Gets the panel with the actions when the header is selected.
ShowActionMode	getSelectedShowActionMode() Gets which actions are shown in the header, when the header is selected.
ShowActionMode	getShowActionMode() Gets which actions are shown in the header, when the header is not selected.
protected javax.swing.JLabel	getTitleLabel() Gets the label with the title.
boolean	isSelected() Determines if the header is selected.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Removes a java.beans.PropertyChangeListener.
void	setPosition(int position) Gets the position of this header.
void	setSelected(boolean selected) Selects or deselects the header.
void	setSelectedShowActionMode(ShowActionMode selectedShowActionMode) Sets which actions are shown in the header, when the header is selected.
void	setShowActionMode(ShowActionMode showActionMode) Sets which actions are shown in the header, when the header is not selected.

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

SelectableDockableHeader

public SelectableDockableHeader(Dockable dockable,
                                int position)

Constructs a small header for a dockable that can be selected.

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.:

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

SelectableDockableHeader

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

Constructs a header for a dockable that can be selected.

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.

Parameters:

dockable - The dockable of the header.

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

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

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

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.

isSelected

public boolean isSelected()

Description copied from interface: SelectableHeader

Determines if the header is selected.

Specified by:

isSelected in interface SelectableHeader

Returns:

True if the header is elected, false otherwise.

setSelected

public void setSelected(boolean selected)

Description copied from interface: SelectableHeader

Selects or deselects the header.

Specified by:

setSelected in interface SelectableHeader

Parameters:

selected - True if the header has to be selected, false otherwise.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: Header

Adds a java.beans.PropertyChangeListener.

Specified by:

addPropertyChangeListener in interface Header

Overrides:

addPropertyChangeListener in class java.awt.Container

Parameters:

listener - The property change listener to be added.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: Header

Removes a java.beans.PropertyChangeListener. This removes a listener.

Specified by:

removePropertyChangeListener in interface Header

Overrides:

removePropertyChangeListener in class java.awt.Component

Parameters:

listener - The property change listener to be removed

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getSelectedShowActionMode

public ShowActionMode getSelectedShowActionMode()

Gets which actions are shown in the header, when the header is selected.

Returns:

Which actions are shown in the header, when the header is selected.

setSelectedShowActionMode

public void setSelectedShowActionMode(ShowActionMode selectedShowActionMode)

Sets which actions are shown in the header, when the header is selected.

Parameters:

selectedShowActionMode - Which actions are shown in the header, when the header is selected.

getShowActionMode

public ShowActionMode getShowActionMode()

Gets which actions are shown in the header, when the header is not selected.

Returns:

Which actions are shown in the header, when the header is not selected.

setShowActionMode

public void setShowActionMode(ShowActionMode showActionMode)

Sets which actions are shown in the header, when the header is not selected.

Parameters:

showActionMode - Which actions are shown in the header, when the header is not selected.

getActionPanel

protected javax.swing.JPanel getActionPanel()

Gets the panel with the actions.

Returns:

The panel with the actions. Can be null.

getSelectedActionPanel

public javax.swing.JPanel getSelectedActionPanel()

Gets the panel with the actions when the header is selected.

Returns:

The panel with the actions when the header is selected. Can be null.

getIconLabel

protected javax.swing.JLabel getIconLabel()

Gets the label with the icon.

Returns:

The label with the icon. Can be null.

getTitleLabel

protected javax.swing.JLabel getTitleLabel()

Gets the label with the title.

Returns:

The label with the title. Can be null.

getHeaderHeight

protected int getHeaderHeight()

Get the height of the header.

Returns:

The height of the header.

getHeaderMaximumWidth

protected int getHeaderMaximumWidth()

Get the maximum width of the header.

Returns:

The maximum width of the header.

calculatePreferredWidth

protected int calculatePreferredWidth()

Calculates the preferred width of the components in the header.

Returns:

The maximum width of the components in the header.