org.tentackle.swing

Class FormButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

org.tentackle.swing.FormButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants, FormChangeable, FormChangeableComponent

Direct Known Subclasses:

GCButton

public class FormButton
extends JButton
implements FormChangeableComponent

A Button which is aware of forms.

Author:

harald

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 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 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
FormButton() Creates a button with no set text or icon.
FormButton(Action a) Creates a button where properties are taken from the Action supplied.
FormButton(Icon icon) Creates a button with an icon.
FormButton(String text) Creates a button with text.
FormButton(String text, Icon icon) Creates a button with initial text and an icon.

Method Summary

Modifier and Type	Method and Description
protected void	fireActionPerformed(ActionEvent event)
String	getHelpURL() Gets the help url.
boolean	isActionPerformedDelayed() Returns whether a button press should be processed delayed or immediately.
boolean	isCellEditorUsage() Returns whether this button is used as a cell editor.
boolean	isChangeable() Returns if this component is changeable.
boolean	isClickOnEnter() Gets the behaviour when user presses the Enter-Key
boolean	isFormTraversable() Returns whether this button is form traversable.
boolean	isHonourChangeable() Returns whether this component should honour the changeable-attribute or not.
protected void	processFocusEvent(FocusEvent e)
protected void	processKeyEvent(KeyEvent e)
void	setActionPerformedDelayed(boolean delayActionPerformed) Sets whether a button press should be processed delayed or immediately.
void	setCellEditorUsage(boolean flag) Sets a flag that this button is used as a cell editor.
void	setChangeable(boolean changeable) Set the component to be changeable. This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.
void	setClickOnEnter(boolean clickOnEnter) Sets the behaviour when user presses the Enter-Key if button has focus.
void	setEnabled(boolean enabled)
void	setFormTraversable(boolean formTraversable) Sets whether this button is form traversable. If the button is traversable it will receive focus according to the keyboard focus policy.
void	setHelpURL(String helpURL) Sets the help url.
void	setHonourChangeable(boolean flag) Sets whether this component should honour the changeable-attribute or not. The default is true.
void	updateAllChangeable(boolean allChangeable) Updates the container's changeable flag.

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, 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, 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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, 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, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormButton

public FormButton()

Creates a button with no set text or icon.

FormButton

public FormButton(Icon icon)

Creates a button with an icon.

Parameters:

icon - the Icon image to display on the button

FormButton

public FormButton(String text)

Creates a button with text.

Parameters:

text - the text of the button

FormButton

public FormButton(Action a)

Creates a button where properties are taken from the Action supplied.

Parameters:

a - the Action used to specify the new button

Since:

1.3

FormButton

public FormButton(String text,
                  Icon icon)

Creates a button with initial text and an icon.

Parameters:

text - the text of the button

icon - the Icon image to display on the button

Method Detail

setChangeable

public void setChangeable(boolean changeable)

Description copied from interface: FormChangeable

Set the component to be changeable.
This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.

Specified by:

setChangeable in interface FormChangeable

Parameters:

changeable - true the user can edit the data, false if show only

isChangeable

public boolean isChangeable()

Description copied from interface: FormChangeable

Returns if this component is changeable.

Specified by:

isChangeable in interface FormChangeable

Returns:

true the user can edit the data, false if show only

setHonourChangeable

public void setHonourChangeable(boolean flag)

Description copied from interface: FormChangeable

Sets whether this component should honour the changeable-attribute or not.
The default is true. Notice: if this component does not honour the changeable flag, isValueChanged() always returns false and it will not perform any saveValue().

Specified by:

setHonourChangeable in interface FormChangeable

Parameters:

flag - true if honour the changeable attribute, false if not

isHonourChangeable

public boolean isHonourChangeable()

Description copied from interface: FormChangeable

Returns whether this component should honour the changeable-attribute or not.

Specified by:

isHonourChangeable in interface FormChangeable

Returns:

true if honour the changeable attribute, false if not

updateAllChangeable

public void updateAllChangeable(boolean allChangeable)

Description copied from interface: FormChangeableComponent

Updates the container's changeable flag.

Whenever FormChangeable.setChangeable(boolean) is invoked all of the container's components get this method invoked.

Specified by:

updateAllChangeable in interface FormChangeableComponent

Parameters:

allChangeable - true if changeable

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class AbstractButton

fireActionPerformed

protected void fireActionPerformed(ActionEvent event)

Overridden to make sure that actionPerformed is executed *after* focusLost has been processed by the opposite component!

Overrides:

fireActionPerformed in class AbstractButton

processFocusEvent

protected void processFocusEvent(FocusEvent e)

Overridden due to tooltip display

Overrides:

processFocusEvent in class Component

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Overridden due to navigation by keys

Overrides:

processKeyEvent in class JComponent

setClickOnEnter

public void setClickOnEnter(boolean clickOnEnter)

Sets the behaviour when user presses the Enter-Key if button has focus.

Parameters:

clickOnEnter - true if pressing the VK_ENTER performs a click, false if transfer focus (default)

isClickOnEnter

public boolean isClickOnEnter()

Gets the behaviour when user presses the Enter-Key

Returns:

true if pressing the VK_ENTER performs a click, false if transfer focus

getHelpURL

public String getHelpURL()

Gets the help url.

Returns:

the help url

setHelpURL

public void setHelpURL(String helpURL)

Sets the help url.

Parameters:

helpURL - the help url

isActionPerformedDelayed

public boolean isActionPerformedDelayed()

Returns whether a button press should be processed delayed or immediately.

Returns:

true if delayed (default), false if immediately (like JButton).

setActionPerformedDelayed

public void setActionPerformedDelayed(boolean delayActionPerformed)

Sets whether a button press should be processed delayed or immediately.

Parameters:

delayActionPerformed - true if delayed (set to end of event queue, default!), false if immediately

isFormTraversable

public boolean isFormTraversable()

Returns whether this button is form traversable.

Returns:

true if traversable, false if not (default)

setFormTraversable

public void setFormTraversable(boolean formTraversable)

Sets whether this button is form traversable.
If the button is traversable it will receive focus according to the keyboard focus policy.

Parameters:

formTraversable - true if traversable, false if not (default)

See Also:

FormFocusTraversalPolicy

setCellEditorUsage

public void setCellEditorUsage(boolean flag)

Sets a flag that this button is used as a cell editor.

Parameters:

flag - true if cell editor

isCellEditorUsage

public boolean isCellEditorUsage()

Returns whether this button is used as a cell editor.

Returns:

true if cell editor