com.lf.commons.gui.button

Class ComboButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

com.lf.commons.gui.button.ComboButton

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.SwingConstants

public class ComboButton
extends javax.swing.JButton
implements java.awt.event.ActionListener, java.awt.event.MouseListener

Special button showing a side component to popup buttons click options.

Implemented like the Thunderbird combo button to update the e-mail account. Default action is to update all accounts, single account updates can be chosen explicitely from the popup list. The list items can be associated with different action commands to allow listeners to take the appropriate steps after the button has been clicked.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JButton

javax.swing.JButton.AccessibleJButton

Nested classes/interfaces inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

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

Modifier and Type	Field and Description
static char	UNICODE_ARROW_DOWN Unicode for an arrow pointing down.

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ComboButton() Constructor of this form.
ComboButton(javax.swing.Action a) Constructor of this form.
ComboButton(javax.swing.Icon icon) Constructor of this form.
ComboButton(java.lang.String text) Constructor of this form.
ComboButton(java.lang.String text, javax.swing.Icon icon) Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever one of the components was activated.
void	addActionListener(java.awt.event.ActionListener listener) Adds a listener to react on main button clicks.
void	addItem(ComboButtonItem item) Adds a new item to be displayed by the popup menu.
protected void	finalize() Clean-up method to help the gc.
ComboButtonItem[]	getItems() Provides the list of managed items.
void	mouseClicked(java.awt.event.MouseEvent event) Implements the MouseListener interface.
void	mouseEntered(java.awt.event.MouseEvent event) Implements the MouseListener interface.
void	mouseExited(java.awt.event.MouseEvent event) Implements the MouseListener interface.
void	mousePressed(java.awt.event.MouseEvent event) Implements the MouseListener interface.
void	mouseReleased(java.awt.event.MouseEvent event) Implements the MouseListener interface.
void	removeActionListener(java.awt.event.ActionListener listener) Removes a listener to react on main button clicks.
void	setActionCommand(java.lang.String command) Sets the default action command.
void	setText(java.lang.String text) Sets the current text shown by the main button.

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeChangeListener, removeItemListener, setAction, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setUI, setVerticalAlignment, setVerticalTextPosition

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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNICODE_ARROW_DOWN

public static final char UNICODE_ARROW_DOWN

Unicode for an arrow pointing down.

See Also:

Constant Field Values

Constructor Detail

ComboButton

public ComboButton()

Constructor of this form.

Since:

1.6

ComboButton

public ComboButton(javax.swing.Action a)

Constructor of this form.

Parameters:

a - The Action used to specify the new button

Since:

1.6

ComboButton

public ComboButton(javax.swing.Icon icon)

Constructor of this form.

Parameters:

icon - The Icon image to display on the button

Since:

1.6

ComboButton

public ComboButton(java.lang.String text)

Constructor of this form.

Parameters:

text - The text of the button

Since:

1.6

ComboButton

public ComboButton(java.lang.String text,
           javax.swing.Icon icon)

Constructor of this form.

Parameters:

text - The text of the button

icon - The Icon image to display on the button

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

setText

public void setText(java.lang.String text)

Sets the current text shown by the main button.

Overrides:

setText in class javax.swing.AbstractButton

Parameters:

text - The text to be shown

Since:

1.6

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Adds a listener to react on main button clicks.

Overrides:

addActionListener in class javax.swing.AbstractButton

Parameters:

listener - The listener

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Removes a listener to react on main button clicks.

Overrides:

removeActionListener in class javax.swing.AbstractButton

Parameters:

listener - The listener

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

addItem

public void addItem(ComboButtonItem item)

Adds a new item to be displayed by the popup menu.

Parameters:

item - The new item

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

getItems

public ComboButtonItem[] getItems()

Provides the list of managed items.

Returns:

The items

Since:

1.6

setActionCommand

public void setActionCommand(java.lang.String command)

Sets the default action command.

Overrides:

setActionCommand in class javax.swing.AbstractButton

Parameters:

command - The command

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)

Implements the MouseListener interface.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Parameters:

event - The event object

Since:

1.6

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)

Implements the MouseListener interface.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Parameters:

event - The event object

Since:

1.6

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)

Implements the MouseListener interface.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Parameters:

event - The event object

Since:

1.6

mousePressed

public void mousePressed(java.awt.event.MouseEvent event)

Implements the MouseListener interface.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Parameters:

event - The event object

Since:

1.6

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)

Implements the MouseListener interface.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Parameters:

event - The event object

Since:

1.6