bibliothek.gui.dock.themes.basic.action.buttons

Class ButtonPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

bibliothek.gui.dock.themes.basic.action.buttons.ButtonPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ButtonPanel
extends JPanel

A panel showing some DockActions. The panel can show a menu for actions which to do not have enough space. Clients using this panel should call getPreferredSizes() to get a list of possible sizes of this panel, and then setVisibleActions(int) in order to use one size. This panel will JComponent.revalidate() itself whenever the number of actions changes.

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

Constructor and Description
ButtonPanel(boolean menu) Creates a new panel

Method Summary

Modifier and Type	Method and Description
protected BasicTitleViewItem<JComponent>	createItemFor(DockAction action, Dockable dockable) Creates a new item for action which will be shown on this panel.
void	doLayout()
Dimension	getCurrentPreferredSize() Gets the preferred size of this panel assuming that not all actions are shown.
int	getItemCount() Gets the number of items which are shown on this panel.
Dimension	getMinimumSize()
DockTitle.Orientation	getOrientation() Gets the orientation of this panel.
Dimension	getPreferredSize()
Dimension[]	getPreferredSizes() Computes the preferred sizes of this panel.
DockActionSource	getSource() Gets the DockActionSource that is currently shown on this panel.
boolean	hasActions() Tells whether this panel shows at least one DockAction.
void	set(Dockable dockable) Changes the content which is shown.
void	set(Dockable dockable, DockActionSource source) Changes the content which is shown.
void	set(Dockable dockable, DockActionSource source, boolean force) Changes the content which is shown.
void	setBackground(Color bg)
void	setController(DockController controller) Sets the DockController in whose realm this panel is used
void	setForeground(Color fg)
void	setOrientation(DockTitle.Orientation orientation) Changes the orientation of this panel.
void	setVisibleActions(int count) Sets the number of actions which should be shown directly on this panel.
void	updateUI()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, getNextFocusableComponent, getPopupLocation, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Constructor Detail

ButtonPanel

public ButtonPanel(boolean menu)

Creates a new panel

Parameters:

menu - whether a menu should be used or not

Method Detail

createItemFor

protected BasicTitleViewItem<JComponent> createItemFor(DockAction action,
                                                       Dockable dockable)

Creates a new item for action which will be shown on this panel. The default implementation will use the ActionViewConverter of dockable to create the view. The ViewTarget is set to ViewTarget.TITLE. Subclasses may override this method to create custom views or use other settings.

Parameters:

action - The action which will be triggered by the button

dockable - The Dockable which will be affected by the action

Returns:

the new graphical representation of the action

getItemCount

public int getItemCount()

Gets the number of items which are shown on this panel.

Returns:

the number of items

setOrientation

public void setOrientation(DockTitle.Orientation orientation)

Changes the orientation of this panel.

Parameters:

orientation - the new orientation

getOrientation

public DockTitle.Orientation getOrientation()

Gets the orientation of this panel. The orientation tells whether the buttons have to be layed out horizontally or vertically.

Returns:

the orientation

set

public void set(Dockable dockable)

Changes the content which is shown.

Parameters:

dockable - the Dockable for which the actions are shown, can be null

getSource

public DockActionSource getSource()

Gets the DockActionSource that is currently shown on this panel.

Returns:

the source that is used, can be null

hasActions

public boolean hasActions()

Tells whether this panel shows at least one DockAction.

Returns:

whether at least one action is present

setController

public void setController(DockController controller)

Sets the DockController in whose realm this panel is used

Parameters:

controller - the controller, can be null

set

public void set(Dockable dockable,
                DockActionSource source)

Changes the content which is shown.

Parameters:

dockable - the Dockable for which the actions are shown, can be null

source - the list of actions, can be null

Throws:

IllegalArgumentException - if dockable or source is null while the other is not null.

set

public void set(Dockable dockable,
                DockActionSource source,
                boolean force)

Changes the content which is shown.

Parameters:

dockable - the Dockable for which the actions are shown, can be null

source - the list of actions, can be null

force - if true, then no optimizations are allowed

Throws:

IllegalArgumentException - if dockable or source is null while the other is not null.

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

updateUI

public void updateUI()

Overrides:

updateUI in class JPanel

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getPreferredSizes

public Dimension[] getPreferredSizes()

Computes the preferred sizes of this panel. Dimension result[n] would be the size required if n actions are shown. The number n should be used for calling setVisibleActions(int).

Returns:

An array of the size of the number of available actions +1.

See Also:

setVisibleActions(int)

getCurrentPreferredSize

public Dimension getCurrentPreferredSize()

Gets the preferred size of this panel assuming that not all actions are shown.

Returns:

the preferred size

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

setVisibleActions

public void setVisibleActions(int count)

Sets the number of actions which should be shown directly on this panel. If not all available actions are shown, the remaining actions are put together in a menu.

Parameters:

count - the number of actions

See Also:

getPreferredSizes()

doLayout

public void doLayout()

Overrides:

doLayout in class Container