Package org.jjazz.flatcomponents.api

Class FlatButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

org.jjazz.flatcomponents.api.FlatButton

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, SwingConstants

Direct Known Subclasses:

FlatHelpButton, FlatToggleButton

public class FlatButton
extends JLabel
implements PropertyChangeListener

A very simple button using a JLabel.

See Also:

• Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

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

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

Constructor Summary

Constructors

Constructor	Description
FlatButton()	Equivalent of FlatButton(true, true, false)
FlatButton(boolean enablePressedBorder, boolean enableEnteredBorder, boolean enableDrag)	Equivalent to FlatButton(null, enablePressedBorder, enableEnteredBorder, enableDrag).
FlatButton(Action a)	Equivalent to FlatButton(a, true, true, false).
FlatButton(Action a, boolean enablePressedBorder, boolean enableEnteredBorder, boolean enableDrag)	Create a FlatButton with the specified settings.

Method Summary

Modifier and Type	Method	Description
void	addActionListener(ActionListener l)	Add an ActionListener which will be called each time button is pressed.
Action	getAction()	The Action associated to this button.
Border	getBorderEntered()
Border	getBorderNothing()
Border	getBorderPressed()
String	getToolTipText()	Overridden to add "OFF" if disabled.
void	propertyChange(PropertyChangeEvent evt)
void	removeActionListener(ActionListener l)
final void	setAction(Action a)	Configure the button to use the below properties and listen to their changes.
void	setBorderEntered(Border b)
void	setBorderNothing(Border b)
void	setBorderPressed(Border b)

Methods inherited from class javax.swing.JLabel

getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FlatButton

public FlatButton()

Equivalent of FlatButton(true, true, false)

FlatButton

public FlatButton(boolean enablePressedBorder,
 boolean enableEnteredBorder,
 boolean enableDrag)

Equivalent to FlatButton(null, enablePressedBorder, enableEnteredBorder, enableDrag).

Parameters:

enablePressedBorder -

enableEnteredBorder -

enableDrag -

FlatButton

public FlatButton(Action a)

Equivalent to FlatButton(a, true, true, false).

Parameters:

a -

FlatButton

public FlatButton(Action a,
 boolean enablePressedBorder,
 boolean enableEnteredBorder,
 boolean enableDrag)

Create a FlatButton with the specified settings.

Parameters:

a - If non null use this action to initialize the button.

enablePressedBorder - True means a specific border is used when pressed.

enableEnteredBorder - True means a specific border is used when entered.

enableDrag - True means mouse drag is possible on this button.

Method Details

addActionListener

public void addActionListener(ActionListener l)

Add an ActionListener which will be called each time button is pressed.

Parameters:

l -

removeActionListener

public void removeActionListener(ActionListener l)

setAction

public final void setAction(Action a)

Configure the button to use the below properties and listen to their changes.

- NAME > setText()
- SHORT_DESCRIPTION > setTooltipText()
- SMALL_ICON > setIcon()
- "JJazzDisabledIcon" > setDisabledIcon()
- "enabled" > setEnabled()

If button is pressed it calls action's actionPerformed() (in addition to the ActionListeners).

If property "hideActionText" is true, ignore the NAME property.

Parameters:

a - A non-null Action.

getAction

public Action getAction()

The Action associated to this button.

Returns:

Null if no action associated.

getBorderNothing

public Border getBorderNothing()

Returns:

getBorderEntered

public Border getBorderEntered()

Returns:

the borderEntered

getBorderPressed

public Border getBorderPressed()

Returns:

the borderPressed

getToolTipText

public String getToolTipText()

Overridden to add "OFF" if disabled.

Overrides:

getToolTipText in class JComponent

Returns:

setBorderEntered

public void setBorderEntered(Border b)

setBorderPressed

public void setBorderPressed(Border b)

setBorderNothing

public void setBorderNothing(Border b)

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener