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
This class defines some stuff necessary for all buttons of the application: a minimum preferred size
(100 x 24 for buttons with text), click on Enter, and factory methods for default buttons with localised caption,
mnemonic and icon (see the
BUTTON_* types).- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class JButton
JButton.AccessibleJButtonNested classes/interfaces inherited from class AbstractButton
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListenerNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringTypes of default buttons.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final intFields inherited from class 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_PROPERTYFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface 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
ConstructorsConstructorDescriptionFWButton()Creates a XButton.Creates a XButton with the given caption.Creates a XButton with a caption from the given locale bundle with the given key.Creates a XButton with the given caption and icon.Creates a XButton with the given action.Creates a XButton with the given icon. -
Method Summary
Modifier and TypeMethodDescriptionstatic FWButtoncreateDefaultButton(String aButtonType, String aActionCommand) Creates a standard button with localised caption, mnemonic and icon of the type.static FWButtoncreateDefaultButton(String aButtonType, String aActionCommand, ActionListener aListener) Creates a standard button with listener.static JToggleButtoncreateToggleButton(String aButtonType, String aActionCommand) Creates a toggle button with localised caption, mnemonic and icon of the type.static ImageIcongetDefaultButtonIcon(String aButtonType) static StringgetLocaleValue(String aKey) Reads a localised text<locale prefix>.FWButton.<key>fromLocaleBundle.(non-Javadoc)(non-Javadoc)(non-Javadoc)final voidkeyPressed(KeyEvent aKeyEvent) Clicks the button when Enter is pressed without modifiers.voidkeyReleased(KeyEvent aKeyEvent) (non-Javadoc)void(non-Javadoc)voidsetContentDescriptionObject(Object aContentDescriptionObject) sets the content description object, made for detailed description of this button.static voidsetDefaultButton(AbstractButton aButton, String aButtonType) Sets localised caption, mnemonic (first character of<type>.Mnemonic) and icon of the type.Methods inherited from class JButton
getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUIMethods inherited from class 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, setVerticalTextPositionMethods inherited from class 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, updateMethods inherited from class 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, validateTreeMethods inherited from class 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
-
Field Details
-
BUTTON_CUT
-
BUTTON_COPY
- See Also:
-
BUTTON_PASTE
- See Also:
-
BUTTON_OK
- See Also:
-
BUTTON_CANCEL
- See Also:
-
BUTTON_LEGEND
- See Also:
-
BUTTON_CLOSE
- See Also:
-
BUTTON_INTERRUPT
- See Also:
-
BUTTON_FINALIZE
- See Also:
-
BUTTON_IMPORT
- See Also:
-
BUTTON_SAVE
- See Also:
-
BUTTON_EXPORT
- See Also:
-
BUTTON_UPGRADE
- See Also:
-
BUTTON_SELECT
- See Also:
-
BUTTON_OPEN
- See Also:
-
BUTTON_DETAILS
- See Also:
-
BUTTON_EXECUTE
- See Also:
-
BUTTON_PRINT
- See Also:
-
BUTTON_INFO
- See Also:
-
BUTTON_NEW
- See Also:
-
BUTTON_ADD
- See Also:
-
BUTTON_REMOVE
- See Also:
-
BUTTON_UPDATE
- See Also:
-
BUTTON_SEARCH
- See Also:
-
BUTTON_GO
- See Also:
-
BUTTON_BACK
- See Also:
-
BUTTON_START
- See Also:
-
BUTTON_STOP
- See Also:
-
BUTTON_TOGGLE
- See Also:
-
BUTTON_RESET
- See Also:
-
BUTTON_RASTERPREVIEW
- See Also:
-
BUTTON_RASTERVALUECHOOSER
- See Also:
-
BUTTON_INFO_MANUAL
- See Also:
-
BUTTON_INFO_EXPLANATION
- See Also:
-
BUTTON_INFO_EXTERNAL
- See Also:
-
BUTTON_INFO_EXTENDED
- See Also:
-
PREFERRED_HEIGHT
public static final int PREFERRED_HEIGHT- See Also:
-
PREFERRED_WIDTH
public static final int PREFERRED_WIDTH- See Also:
-
-
Constructor Details
-
FWButton
public FWButton()Creates a XButton. -
FWButton
-
FWButton
Creates a XButton with the given caption.- Parameters:
aCaption- the caption
-
FWButton
-
FWButton
-
FWButton
Creates a XButton with the given action.- Parameters:
aAction- the action
-
-
Method Details
-
getMinimumSize
(non-Javadoc)- Overrides:
getMinimumSizein classJComponent- See Also:
-
getPreferredSize
(non-Javadoc)- Overrides:
getPreferredSizein classJComponent- See Also:
-
getMaximumSize
(non-Javadoc)- Overrides:
getMaximumSizein classJComponent- See Also:
-
keyPressed
Clicks the button when Enter is pressed without modifiers.- Specified by:
keyPressedin interfaceKeyListener- Parameters:
aKeyEvent- the key event
-
keyReleased
(non-Javadoc)- Specified by:
keyReleasedin interfaceKeyListener- See Also:
-
keyTyped
(non-Javadoc)- Specified by:
keyTypedin interfaceKeyListener- See Also:
-
createToggleButton
Creates a toggle button with localised caption, mnemonic and icon of the type.- Parameters:
aButtonType- button type, one of theBUTTON_*constantsaActionCommand- action command- Returns:
- the toggle button
-
createDefaultButton
-
setDefaultButton
Sets localised caption, mnemonic (first character of<type>.Mnemonic) and icon of the type.- Parameters:
aButton- the buttonaButtonType- button type, one of theBUTTON_*constants
-
createDefaultButton
public static FWButton createDefaultButton(String aButtonType, String aActionCommand, ActionListener aListener) Creates a standard button with listener.- Parameters:
aButtonType- button type, one of theBUTTON_*constantsaActionCommand- action commandaListener- listener, ornull- Returns:
- the button
-
getLocaleValue
-
getDefaultButtonIcon
-
getContentDescriptionObject
- Returns:
- the content description object, made for detailed description of this button.
-
setContentDescriptionObject
sets the content description object, made for detailed description of this button.- Parameters:
aContentDescriptionObject- the description object
-