com.metamatrix.toolbox.ui.widget
Class ButtonWidget

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      com.metamatrix.toolbox.ui.widget.ButtonWidget

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

Direct Known Subclasses:

ActionFireableButtonWidget, JEnterButton, PasswordButton, TableHeaderButton

public class ButtonWidget
extends javax.swing.JButton

This class is intended to be used everywhere within the application that a button needs to be displayed.

Since:

2.0

Version:

2.0

Author:

John P. A. Verhaeg

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

static java.lang.String	BORDER_PROPERTY
static java.lang.String	ICON_PROPERTY_SUFFIX
static java.lang.String	MARGIN_PROPERTY
static java.lang.String	MNEMONIC_PROPERTY_SUFFIX
static java.lang.String	PRESSED_BORDER_PROPERTY
static java.lang.String	PROPERTY_PREFIX

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

ButtonWidget()
Creates a blank button.

ButtonWidget(javax.swing.Action a)
Creates a button with the specified text and icon.

ButtonWidget(javax.swing.Icon icon)
Creates a button with the specified icon.

ButtonWidget(java.lang.String text)
Creates a button with the specified text.

ButtonWidget(java.lang.String text, javax.swing.Icon icon)
Creates a button with the specified text and icon.

Method Summary

javax.swing.JToolTip	createToolTip()
protected void	fireActionPerformed(java.awt.event.ActionEvent event) Fires a WidgetActionEvent instead of an ActionEvent to allow it to be marked as processed by listeners.
int	getIconTextGap()
int	getPressedShift()
java.lang.String	getTextFormat()
protected void	initializeButtonWidget() Registers the key as an 'action' key (i.e., it performs the same function as the key).
boolean	isFocusTraversable()
void	setFocusTraversable(boolean flag)
void	setIconTextGap(int iconTextGap)
void	setPressedShift(int pressedShift)
void	setText(java.lang.String text)
java.lang.String	toString()
void	updateUI()

Methods inherited from class javax.swing.JButton

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

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, 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, 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, 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, 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, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, 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, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_PREFIX

public static final java.lang.String PROPERTY_PREFIX

See Also:

Constant Field Values

ICON_PROPERTY_SUFFIX

public static final java.lang.String ICON_PROPERTY_SUFFIX

See Also:

Constant Field Values

MNEMONIC_PROPERTY_SUFFIX

public static final java.lang.String MNEMONIC_PROPERTY_SUFFIX

See Also:

Constant Field Values

MARGIN_PROPERTY

public static final java.lang.String MARGIN_PROPERTY

See Also:

Constant Field Values

BORDER_PROPERTY

public static final java.lang.String BORDER_PROPERTY

See Also:

Constant Field Values

PRESSED_BORDER_PROPERTY

public static final java.lang.String PRESSED_BORDER_PROPERTY

See Also:

Constant Field Values

Constructor Detail

ButtonWidget

public ButtonWidget()

Creates a blank button.

Since:

2.0

ButtonWidget

public ButtonWidget(java.lang.String text)

Creates a button with the specified text.

Parameters:

text - The text

Since:

2.0

ButtonWidget

public ButtonWidget(javax.swing.Icon icon)

Creates a button with the specified icon.

Parameters:

icon - The icon

Since:

2.0

ButtonWidget

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

Creates a button with the specified text and icon. The button is by default laid out with the icon to the left of the text.

Parameters:

text - The text

icon - The icon

Since:

2.0

ButtonWidget

public ButtonWidget(javax.swing.Action a)

Creates a button with the specified text and icon. The button is by default laid out with the icon to the left of the text.

Parameters:

text - The text

icon - The icon

Since:

2.0

Method Detail

createToolTip

public javax.swing.JToolTip createToolTip()

Overrides:

createToolTip in class javax.swing.JComponent

fireActionPerformed

protected void fireActionPerformed(java.awt.event.ActionEvent event)

Fires a WidgetActionEvent instead of an ActionEvent to allow it to be marked as processed by listeners.

Overrides:

fireActionPerformed in class javax.swing.AbstractButton

Since:

2.0

getIconTextGap

public int getIconTextGap()

Overrides:

getIconTextGap in class javax.swing.AbstractButton

Since:

2.0

getPressedShift

public int getPressedShift()

Since:

2.0

getTextFormat

public java.lang.String getTextFormat()

Returns:

The text format

Since:

2.0

initializeButtonWidget

protected void initializeButtonWidget()

Registers the key as an 'action' key (i.e., it performs the same function as the key).

Since:

2.0

setIconTextGap

public void setIconTextGap(int iconTextGap)

Overrides:

setIconTextGap in class javax.swing.AbstractButton

Since:

2.0

setPressedShift

public void setPressedShift(int pressedShift)

Since:

2.0

setText

public void setText(java.lang.String text)

Overrides:

setText in class javax.swing.AbstractButton

Since:

2.0

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

Returns:

The text

Since:

2.0

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JButton

Since:

2.0

setFocusTraversable

public void setFocusTraversable(boolean flag)

Since:

3.1

isFocusTraversable

public boolean isFocusTraversable()

Overrides:

isFocusTraversable in class java.awt.Component

Since:

3.1

See Also:

Component.isFocusTraversable()