Package net.simplace.pipe.util.components

Class FWButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

net.simplace.pipe.util.components.FWButton

All Implemented Interfaces:

KeyListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

Direct Known Subclasses:

FWAbstractPopUpButton

public class FWButton
extends JButton
implements KeyListener

This class defines some stuff necessary for all buttons of the application. For example the same preferred size.

See Also:

• Serialized Form

Nested Class Summary

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

JButton.AccessibleJButton

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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

Modifier and Type	Field	Description
static final String	BUTTON_ADD
static final String	BUTTON_BACK
static final String	BUTTON_CANCEL
static final String	BUTTON_CLOSE
static final String	BUTTON_COPY
static final String	BUTTON_CUT	Types of default buttons.
static final String	BUTTON_DETAILS
static final String	BUTTON_EXECUTE
static final String	BUTTON_EXPORT
static final String	BUTTON_FINALIZE
static final String	BUTTON_GO
static final String	BUTTON_IMPORT
static final String	BUTTON_INFO
static final String	BUTTON_INFO_EXPLANATION
static final String	BUTTON_INFO_EXTENDED
static final String	BUTTON_INFO_EXTERNAL
static final String	BUTTON_INFO_MANUAL
static final String	BUTTON_INTERRUPT
static final String	BUTTON_LEGEND
static final String	BUTTON_NEW
static final String	BUTTON_OK
static final String	BUTTON_OPEN
static final String	BUTTON_PASTE
static final String	BUTTON_PRINT
static final String	BUTTON_RASTERPREVIEW
static final String	BUTTON_RASTERVALUECHOOSER
static final String	BUTTON_REMOVE
static final String	BUTTON_RESET
static final String	BUTTON_SAVE
static final String	BUTTON_SEARCH
static final String	BUTTON_SELECT
static final String	BUTTON_START
static final String	BUTTON_STOP
static final String	BUTTON_TOGGLE
static final String	BUTTON_UPDATE
static final String	BUTTON_UPGRADE
static final int	PREFERRED_HEIGHT
static final int	PREFERRED_WIDTH

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

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

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
FWButton()	Creates a XButton.
FWButton(String aCaption)	Creates a XButton with the given caption.
FWButton(String aLocale, String aLocaleKey)	Creates a XButton with from the given locale with the given key.
FWButton(String aCaption, Icon aIcon)	Creates a XButton with the given caption and icon.
FWButton(Action aAction)	Creates a XButton with the given action.
FWButton(Icon aIcon)	Creates a XButton with the given icon.

Method Summary

Modifier and Type	Method	Description
static FWButton	createDefaultButton(String aButtonType, String aActionCommand)	Creates a standard button
static FWButton	createDefaultButton(String aButtonType, String aActionCommand, ActionListener aListener)	Creates a standard button
static JToggleButton	createToggleButton(String aButtonType, String aActionCommand)	Creates a standard button
Object	getContentDescriptionObject()
static ImageIcon	getDefaultButtonIcon(String aButtonType)	Method getDefaultButtonIcon.
static String	getLocaleValue(String aKey)	This method limits the coding for reading values from the locale.
Dimension	getMaximumSize()	(non-Javadoc)
Dimension	getMinimumSize()	(non-Javadoc)
Dimension	getPreferredSize()	(non-Javadoc)
final void	keyPressed(KeyEvent aKeyEvent)	Performs the event for the button.
void	keyReleased(KeyEvent aKeyEvent)	(non-Javadoc)
void	keyTyped(KeyEvent aKeyEvent)	(non-Javadoc)
void	setContentDescriptionObject(Object aContentDescriptionObject)	sets the content description object, made for detailed description of this button.
static void	setDefaultButton(AbstractButton aButton, String aButtonType)	Sets the values to the xbutton.

Methods inherited from class javax.swing.JButton

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

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, 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, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, 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, setText, 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, 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, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, 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

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

Field Details

BUTTON_CUT

public static final String BUTTON_CUT

Types of default buttons.

See Also:

• Constant Field Values

BUTTON_COPY

public static final String BUTTON_COPY

See Also:

• Constant Field Values

BUTTON_PASTE

public static final String BUTTON_PASTE

See Also:

• Constant Field Values

BUTTON_OK

public static final String BUTTON_OK

See Also:

• Constant Field Values

BUTTON_CANCEL

public static final String BUTTON_CANCEL

See Also:

• Constant Field Values

BUTTON_LEGEND

public static final String BUTTON_LEGEND

See Also:

• Constant Field Values

BUTTON_CLOSE

public static final String BUTTON_CLOSE

See Also:

• Constant Field Values

BUTTON_INTERRUPT

public static final String BUTTON_INTERRUPT

See Also:

• Constant Field Values

BUTTON_FINALIZE

public static final String BUTTON_FINALIZE

See Also:

• Constant Field Values

BUTTON_IMPORT

public static final String BUTTON_IMPORT

See Also:

• Constant Field Values

BUTTON_SAVE

public static final String BUTTON_SAVE

See Also:

• Constant Field Values

BUTTON_EXPORT

public static final String BUTTON_EXPORT

See Also:

• Constant Field Values

BUTTON_UPGRADE

public static final String BUTTON_UPGRADE

See Also:

• Constant Field Values

BUTTON_SELECT

public static final String BUTTON_SELECT

See Also:

• Constant Field Values

BUTTON_OPEN

public static final String BUTTON_OPEN

See Also:

• Constant Field Values

BUTTON_DETAILS

public static final String BUTTON_DETAILS

See Also:

• Constant Field Values

BUTTON_EXECUTE

public static final String BUTTON_EXECUTE

See Also:

• Constant Field Values

BUTTON_PRINT

public static final String BUTTON_PRINT

See Also:

• Constant Field Values

BUTTON_INFO

public static final String BUTTON_INFO

See Also:

• Constant Field Values

BUTTON_NEW

public static final String BUTTON_NEW

See Also:

• Constant Field Values

BUTTON_ADD

public static final String BUTTON_ADD

See Also:

• Constant Field Values

BUTTON_REMOVE

public static final String BUTTON_REMOVE

See Also:

• Constant Field Values

BUTTON_UPDATE

public static final String BUTTON_UPDATE

See Also:

• Constant Field Values

BUTTON_SEARCH

public static final String BUTTON_SEARCH

See Also:

• Constant Field Values

BUTTON_GO

public static final String BUTTON_GO

See Also:

• Constant Field Values

BUTTON_BACK

public static final String BUTTON_BACK

See Also:

• Constant Field Values

BUTTON_START

public static final String BUTTON_START

See Also:

• Constant Field Values

BUTTON_STOP

public static final String BUTTON_STOP

See Also:

• Constant Field Values

BUTTON_TOGGLE

public static final String BUTTON_TOGGLE

See Also:

• Constant Field Values

BUTTON_RESET

public static final String BUTTON_RESET

See Also:

• Constant Field Values

BUTTON_RASTERPREVIEW

public static final String BUTTON_RASTERPREVIEW

See Also:

• Constant Field Values

BUTTON_RASTERVALUECHOOSER

public static final String BUTTON_RASTERVALUECHOOSER

See Also:

• Constant Field Values

BUTTON_INFO_MANUAL

public static final String BUTTON_INFO_MANUAL

See Also:

• Constant Field Values

BUTTON_INFO_EXPLANATION

public static final String BUTTON_INFO_EXPLANATION

See Also:

• Constant Field Values

BUTTON_INFO_EXTERNAL

public static final String BUTTON_INFO_EXTERNAL

See Also:

• Constant Field Values

BUTTON_INFO_EXTENDED

public static final String BUTTON_INFO_EXTENDED

See Also:

• Constant Field Values

PREFERRED_HEIGHT

public static final int PREFERRED_HEIGHT

See Also:

• Constant Field Values

PREFERRED_WIDTH

public static final int PREFERRED_WIDTH

See Also:

• Constant Field Values

Constructor Details

FWButton

public FWButton()

Creates a XButton.

FWButton

public FWButton(Icon aIcon)

Creates a XButton with the given icon.

Parameters:

aIcon -

FWButton

public FWButton(String aCaption)

Creates a XButton with the given caption.

Parameters:

aCaption -

FWButton

public FWButton(String aLocale,
 String aLocaleKey)

Creates a XButton with from the given locale with the given key.

Parameters:

aLocale -

aLocaleKey -

FWButton

public FWButton(String aCaption,
 Icon aIcon)

Creates a XButton with the given caption and icon.

Parameters:

aCaption -

aIcon -

FWButton

public FWButton(Action aAction)

Creates a XButton with the given action.

Parameters:

aAction -

Method Details

getMinimumSize

public Dimension getMinimumSize()

(non-Javadoc)

Overrides:

getMinimumSize in class JComponent

See Also:

• JComponent.getMinimumSize()

getPreferredSize

public Dimension getPreferredSize()

(non-Javadoc)

Overrides:

getPreferredSize in class JComponent

See Also:

• JComponent.getPreferredSize()

getMaximumSize

public Dimension getMaximumSize()

(non-Javadoc)

Overrides:

getMaximumSize in class JComponent

See Also:

• JComponent.getMaximumSize()

keyPressed

public final void keyPressed(KeyEvent aKeyEvent)

Performs the event for the button.

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent aKeyEvent)

(non-Javadoc)

Specified by:

keyReleased in interface KeyListener

See Also:

• KeyListener.keyReleased(java.awt.event.KeyEvent)

keyTyped

public void keyTyped(KeyEvent aKeyEvent)

(non-Javadoc)

Specified by:

keyTyped in interface KeyListener

See Also:

• KeyListener.keyTyped(java.awt.event.KeyEvent)

createToggleButton

public static JToggleButton createToggleButton(String aButtonType,
 String aActionCommand)

Creates a standard button

Parameters:

aButtonType -

aActionCommand -

Returns:

the default button

createDefaultButton

public static FWButton createDefaultButton(String aButtonType,
 String aActionCommand)

Creates a standard button

Parameters:

aButtonType -

aActionCommand -

Returns:

the default button

setDefaultButton

public static void setDefaultButton(AbstractButton aButton,
 String aButtonType)

Sets the values to the xbutton.

Parameters:

aButton -

aButtonType -

createDefaultButton

public static FWButton createDefaultButton(String aButtonType,
 String aActionCommand,
 ActionListener aListener)

Creates a standard button

Parameters:

aButtonType -

aActionCommand -

aListener -

Returns:

the button

getLocaleValue

public static String getLocaleValue(String aKey)

This method limits the coding for reading values from the locale.

Parameters:

aKey -

Returns:

getDefaultButtonIcon

public static ImageIcon getDefaultButtonIcon(String aButtonType)

Method getDefaultButtonIcon.

Parameters:

aButtonType -

Returns:

Icon

getContentDescriptionObject

public Object getContentDescriptionObject()

Returns:

the content description object, made for detailed description of this button.

setContentDescriptionObject

public void setContentDescriptionObject(Object aContentDescriptionObject)

sets the content description object, made for detailed description of this button.

Parameters:

aContentDescriptionObject -