FormCheckBox (Tentackle Swing 2.1.1 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.AbstractButton
      - javax.swing.JToggleButton
        
        javax.swing.JCheckBox
        
        org.tentackle.swing.FormCheckBox

All Implemented Interfaces:

ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, SwingConstants, FormChangeable, FormChangeableComponent, FormComponent

Direct Known Subclasses:

AcceptDenyCheckBox
```
public class FormCheckBox
extends JCheckBox
implements FormComponent, ActionListener
```
A checkbox aware of forms.

Author:

harald

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JCheckBox
  JCheckBox.AccessibleJCheckBox
- Nested classes/interfaces inherited from class javax.swing.JToggleButton
  JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel
- 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.JCheckBox
  BORDER_PAINTED_FLAT_CHANGED_PROPERTY
- 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
`FormCheckBox()` Creates a check box without text, unselected.
`FormCheckBox(String text)` Creates a check box with text, unselected.
`FormCheckBox(String text, boolean selected)` Creates a check box with text and specifies whether or not it is initially selected.
`FormCheckBox(String text, Icon icon, boolean selected)` Creates a check box with text and icon, and specifies whether or not it is initially selected.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent evt)`
`void`	`addValueListener(ValueListener l)` Adds a value listener that implements the binding between this component and the data.
`void`	`clearValueShownModified()` Clears the value shown status. May be used by components that update the value shown programmatically.
`void`	`fireValueChanged()` Fires all value listeners registered on this component invoking their `valueChanged`-handler. This method is invoked whenever the data has been changed and that change should be reflected in the view.
`void`	`fireValueEntered()` Fires all listeners registered on this component invoking their `valueEntered`-handler. This method is invoked whenever the user edited the view and that change should be reflected in the data.
`FormComponentBinding`	`getBinding()` Gets the binding.
`String`	`getBindingPath()` Gets the binding path.
`String`	`getComponentPath()` Gets the component path.
`FocusTraversalGroup`	`getFocusTraversalGroup()` Gets the focus traversal group for this component.
`Boolean`	`getFormValue()` Retrieves the value from this component. The method is used to update the data model if the view has changed because the user edited it.
`String`	`getHelpURL()` Gets the online-help URL.
`Window`	`getParentWindow()` Gets the parent window of this component.
`PropertyGroup`	`getPropertyGroup()` Gets the property group for this component.
`Color`	`getSelectedColor()` Gets the color for "checked".
`String`	`getToolTipText()`
`Color`	`getUnselectedColor()` Gets the color for "unchecked".
`Boolean`	`getValueShown()` Gets the value shown to the user. This is the visual representation, not necessarily the model's value.
`void`	`invalidateParentInfo()` Invalidates all container-relevant (cached) information for the hierarchy of this component's parents. For optimization purposes.
`boolean`	`isAutoUpdate()` Returns whether the auto-update feature is enabled.
`boolean`	`isBindable()` Determines whether this component is bindable.
`boolean`	`isCellEditorUsage()` Returns whether this component is used as a cell editor.
`boolean`	`isChangeable()` Returns if this component is changeable.
`boolean`	`isFireRunning()` Checks whether a fire-method is running.
`boolean`	`isFormTraversable()` Returns whether this component is form traversable or not.
`boolean`	`isHonourChangeable()` Returns whether this component should honour the changeable-attribute or not.
`boolean`	`isMandatory()` Gets the mandatory option.
`boolean`	`isSmartValueEntered()` Returns whether the model should only be updated if the component's value really changed. The default is true.
`boolean`	`isTriggerValueChangedEnabled()` Determines whether triggering value changes is enabled.
`boolean`	`isValueChanged()` Checks whether the contents have been changed since the last savepoint.
`boolean`	`isValueShownModified()` Checks whether the currently shown value differs from the initially shown. Used to implement smartValueEntered.
`void`	`prepareFocusLost()` Prepares for FOCUS_LOST. Gives this component the opportunity to invoke fireValueEntered() earlier than FOCUS_LOST is really received.
`protected void`	`processFocusEvent(FocusEvent e)`
`protected void`	`processKeyEvent(KeyEvent e)`
`void`	`removeValueListener(ValueListener l)` Remove a value listener.
`void`	`requestFocusLater()` Requests the keyboard focus for this component by appending an event to the end of the event queue. Applications should not use requestFocus() or requestFocusInWindow() unless the order in which the events are processed is unimportant.
`void`	`saveValue()` Sets a savepoint for the data of this component. Allows to decide whether the user has changed the data associated with this component or not.
`void`	`setAutoUpdate(boolean autoupdate)` Sets the auto-update feature. By default, all components update the data model if the view changes (due to certain events, for example focus lost).
`void`	`setBindable(boolean bindable)` Sets whether this component is bindable.
`void`	`setBinding(FormComponentBinding binding)` Sets the binding.
`void`	`setBindingPath(String bindingPath)` Sets the path to bind this component to.
`void`	`setCellEditorUsage(boolean flag)` Sets a hint that this component is used as a cell editor. Some components behave differently in tables than in forms, for example.
`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`	`setComponentPath(String componentPath)` Sets the component path.
`void`	`setEnabled(boolean enabled)`
`void`	`setFireRunning(boolean running)` Sets a component's flag that a fire-method is currently running. Used by the framework to minimize valueChanged/valueEntered processing.
`void`	`setFocusTraversalGroup(FocusTraversalGroup group)` Sets the focus traversal group for this component.
`void`	`setFormTraversable(boolean formTraversable)` Sets whether this component is form traversable or not, i.e.
`void`	`setFormValue(Object selected)` Sets a value in this component. The method is used to update the view if the data has changed.
`void`	`setFormWrapWindow(FormWindow parent)` Sets the window that will fire a `FormWrapEvent` when this components loses the keyboard focus.
`void`	`setHelpURL(String helpURL)` Sets the online-help URL. If a help url is set for this component, a browser will be launched to show that url.
`void`	`setHonourChangeable(boolean flag)` Sets whether this component should honour the changeable-attribute or not. The default is true.
`void`	`setMandatory(boolean mandatory)` Sets the mandatory option. Mandatory fields are differently visualized.
`void`	`setPropertyGroup(PropertyGroup group)` Sets the property group for this component.
`void`	`setSelectedColor(Color selectedColor)` Sets the color when item is selected. If the selected color is set, the deselected color should be set too.
`void`	`setSmartValueEntered(boolean smartValueEntered)` Sets whether the model should only be updated if the component's value really changed. The default is true.
`void`	`setTriggerValueChangedEnabled(boolean enabled)` Enables triggering value changes. Disabling this feature may be necessary for model-agnostic components.
`void`	`setUnselectedColor(Color unselectedColor)` Sets the color when item is unselected. If the unselected color is set, the selected color should be set too.
`void`	`showErrorPopup(String message)` Shows the error popup for a given message. The popup component used is an `ErrorToolTip`.
`void`	`showHelp()` Displays online help for this component. Usually triggered by KeyEvent.VK_F1 or VK_HELP or a button.
`void`	`transferFocus()` Transfers keyboard focus forward to the logically next component.
`void`	`transferFocusBackward()` Transfers keyboard focus forward to the logically previous component.
`void`	`triggerValueChanged()` Promotes the fact that value changed to all `FormContainer`s this component is a child of.
`void`	`updateAllChangeable(boolean allChangeable)` Updates the container's changeable flag.
`boolean`	`wasFocusGainedFromTransfer()` Returns whether the keyboard focus was gained due to `FormComponent.transferFocus()` in the opposite component.
`boolean`	`wasFocusGainedFromTransferBackward()` Returns whether the keyboard focus was gained due to `FormComponent.transferFocusBackward()` in the opposite component.
`boolean`	`wasTransferFocus()` Returns whether this component lost the keyboard focus due to `FormComponent.transferFocus()`.
`boolean`	`wasTransferFocusBackward()` Returns whether this component lost the keyboard focus due to `FormComponent.transferFocusBackward()`.
`boolean`	`wasTransferFocusByEnter()` Returns whether this component lost the keyboard focus due to `KeyEvent.VK_ENTER`.

Methods inherited from class javax.swing.JCheckBox
getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat, 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, removeNotify, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.swing.FormComponent
getBaseline, hasFocus

- Constructor Detail
  - FormCheckBox
```
public FormCheckBox(String text,
                    Icon icon,
                    boolean selected)
```
    Creates a check box with text and icon, and specifies whether or not it is initially selected.
    
    Parameters:
    
    text - the text of the check box.
    
    icon - the Icon image to display
    
    selected - a boolean value indicating the initial selection state. If true the check box is selected
  - FormCheckBox
```
public FormCheckBox(String text,
                    boolean selected)
```
    Creates a check box with text and specifies whether or not it is initially selected.
    
    Parameters:
    
    text - the text of the check box.
    
    selected - a boolean value indicating the initial selection state. If true the check box is selected
  - FormCheckBox
```
public FormCheckBox(String text)
```
    Creates a check box with text, unselected.
    
    Parameters:
    
    text - the text of the check box.
  - FormCheckBox
```
public FormCheckBox()
```
    Creates a check box without text, unselected.
- Method Detail
  - showErrorPopup
```
public void showErrorPopup(String message)
```
    Description copied from interface: FormComponent
    
    Shows the error popup for a given message.
    The popup component used is an ErrorToolTip.
    
    Specified by:
    
    showErrorPopup in interface FormComponent
    
    Parameters:
    
    message - the message to be displayed, null to remove
  - getSelectedColor
```
public Color getSelectedColor()
```
    Gets the color for "checked".
    
    Returns:
    
    the selected color
  - setSelectedColor
```
public void setSelectedColor(Color selectedColor)
```
    Sets the color when item is selected.
    If the selected color is set, the deselected color should be set too. If the tentackle-plafs are used, these colors will be used regardless whether the component is enabled or not. This is a nice feature to circumvent the half-intensity display of disabled components.
    
    Parameters:
    
    selectedColor - the selected color, null if default
  - getUnselectedColor
```
public Color getUnselectedColor()
```
    Gets the color for "unchecked".
    
    Returns:
    
    the unselected color
  - setUnselectedColor
```
public void setUnselectedColor(Color unselectedColor)
```
    Sets the color when item is unselected.
    If the unselected color is set, the selected color should be set too. If the tentackle-plafs are used, these colors will be used regardless whether the component is enabled or not. This is a nice feature to circumvent the half-intensity display of disabled components.
    
    Parameters:
    
    unselectedColor - the unselected color, null if default
  - setAutoUpdate
```
public void setAutoUpdate(boolean autoupdate)
```
    Description copied from interface: FormComponent
    
    Sets the auto-update feature.
    By default, all components update the data model if the view changes (due to certain events, for example focus lost).
    
    Specified by:
    
    setAutoUpdate in interface FormComponent
    
    Parameters:
    
    autoupdate - true if auto update the data (default), false if not
  - isAutoUpdate
```
public boolean isAutoUpdate()
```
    Description copied from interface: FormComponent
    
    Returns whether the auto-update feature is enabled.
    
    Specified by:
    
    isAutoUpdate in interface FormComponent
    
    Returns:
    
    true if auto update the data (default), false if not
  - getToolTipText
```
public String getToolTipText()
```
    Overridden to show tooltip in tooltipdisplay _or_ via mouse hover but _not_ both.
    
    Overrides:
    
    getToolTipText in class JComponent
  - transferFocus
```
public void transferFocus()
```
    Description copied from interface: FormComponent
    
    Transfers keyboard focus forward to the logically next component.
    
    Specified by:
    
    transferFocus in interface FormComponent
    
    Overrides:
    
    transferFocus in class Component
    
    See Also:
    
    FormFocusTraversalPolicy
  - transferFocusBackward
```
public void transferFocusBackward()
```
    Description copied from interface: FormComponent
    
    Transfers keyboard focus forward to the logically previous component.
    
    Specified by:
    
    transferFocusBackward in interface FormComponent
    
    Overrides:
    
    transferFocusBackward in class Component
    
    See Also:
    
    FormFocusTraversalPolicy
  - processKeyEvent
```
protected void processKeyEvent(KeyEvent e)
```
    Overridden to implement keyboard shortcuts.
    
    Overrides:
    
    processKeyEvent in class JComponent
  - processFocusEvent
```
protected void processFocusEvent(FocusEvent e)
```
    Overridden for advanced focus handling
    
    Overrides:
    
    processFocusEvent in class Component
  - requestFocusLater
```
public void requestFocusLater()
```
    Description copied from interface: FormComponent
    
    Requests the keyboard focus for this component by appending an event to the end of the event queue.
    Applications should not use requestFocus() or requestFocusInWindow() unless the order in which the events are processed is unimportant. This method guarantees that this component gets the focus when all events queued so far have been processed.
    
    Specified by:
    
    requestFocusLater in interface FormComponent
  - actionPerformed
```
public void actionPerformed(ActionEvent evt)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - addValueListener
```
public void addValueListener(ValueListener l)
```
    Description copied from interface: FormComponent
    
    Adds a value listener that implements the binding between this component and the data.
    
    Specified by:
    
    addValueListener in interface FormComponent
    
    Parameters:
    
    l - the value listener to add
  - removeValueListener
```
public void removeValueListener(ValueListener l)
```
    Description copied from interface: FormComponent
    
    Remove a value listener.
    
    Specified by:
    
    removeValueListener in interface FormComponent
    
    Parameters:
    
    l - the value listener to remove
  - fireValueChanged
```
public void fireValueChanged()
```
    Description copied from interface: FormComponent
    
    Fires all value listeners registered on this component invoking their valueChanged-handler.
    This method is invoked whenever the data has been changed and that change should be reflected in the view.
    
    Specified by:
    
    fireValueChanged in interface FormComponent
  - fireValueEntered
```
public void fireValueEntered()
```
    Description copied from interface: FormComponent
    
    Fires all listeners registered on this component invoking their valueEntered-handler.
    This method is invoked whenever the user edited the view and that change should be reflected in the data.
    
    Specified by:
    
    fireValueEntered in interface FormComponent
  - setFormValue
```
public void setFormValue(Object selected)
```
    Sets a value in this component.
    The method is used to update the view if the data has changed.
    
    Specified by:
    
    setFormValue in interface FormComponent
    
    Parameters:
    
    selected - a Boolean object, else the checkbox is unselected
  - getFormValue
```
public Boolean getFormValue()
```
    Retrieves the value from this component.
    The method is used to update the data model if the view has changed because the user edited it.
    
    Specified by:
    
    getFormValue in interface FormComponent
    
    Returns:
    
    either Boolean.TRUE or Boolean.FALSE
  - saveValue
```
public void saveValue()
```
    Description copied from interface: FormComponent
    
    Sets a savepoint for the data of this component.
    Allows to decide whether the user has changed the data associated with this component or not.
    
    Specified by:
    
    saveValue in interface FormComponent
    
    See Also:
    
    FormComponent.isValueChanged()
  - isValueChanged
```
public boolean isValueChanged()
```
    Description copied from interface: FormComponent
    
    Checks whether the contents have been changed since the last savepoint.
    
    Specified by:
    
    isValueChanged in interface FormComponent
    
    Returns:
    
    true if changed
    
    See Also:
    
    FormComponent.saveValue()
  - setTriggerValueChangedEnabled
```
public void setTriggerValueChangedEnabled(boolean enabled)
```
    Description copied from interface: FormComponent
    
    Enables triggering value changes.
    Disabling this feature may be necessary for model-agnostic components.
    
    Specified by:
    
    setTriggerValueChangedEnabled in interface FormComponent
    
    Parameters:
    
    enabled - true if invoke FormComponent.triggerValueChanged() on each change (default), false if not.
  - isTriggerValueChangedEnabled
```
public boolean isTriggerValueChangedEnabled()
```
    Description copied from interface: FormComponent
    
    Determines whether triggering value changes is enabled.
    
    Specified by:
    
    isTriggerValueChangedEnabled in interface FormComponent
    
    Returns:
    
    true if invoke FormComponent.triggerValueChanged() on each change (default), false if not.
  - triggerValueChanged
```
public void triggerValueChanged()
```
    Description copied from interface: FormComponent
    
    Promotes the fact that value changed to all FormContainers this component is a child of.
    
    Specified by:
    
    triggerValueChanged in interface FormComponent
  - 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
  - setFireRunning
```
public void setFireRunning(boolean running)
```
    Description copied from interface: FormComponent
    
    Sets a component's flag that a fire-method is currently running.
    Used by the framework to minimize valueChanged/valueEntered processing.
    
    Specified by:
    
    setFireRunning in interface FormComponent
    
    Parameters:
    
    running - true if some fire-method is running
  - isFireRunning
```
public boolean isFireRunning()
```
    Description copied from interface: FormComponent
    
    Checks whether a fire-method is running.
    
    Specified by:
    
    isFireRunning in interface FormComponent
    
    Returns:
    
    true if some fire-method is running
  - prepareFocusLost
```
public void prepareFocusLost()
```
    Description copied from interface: FormComponent
    
    Prepares for FOCUS_LOST.
    Gives this component the opportunity to invoke fireValueEntered() earlier than FOCUS_LOST is really received. Useful because the next focused component is determined before FOCUS_LOST is sent to this component. Thus, if this component changes the focusability of the next component, the focus policy would probably pick the wrong component otherwise.
    
    Specified by:
    
    prepareFocusLost in interface FormComponent
  - setFormWrapWindow
```
public void setFormWrapWindow(FormWindow parent)
```
    Description copied from interface: FormComponent
    
    Sets the window that will fire a FormWrapEvent when this components loses the keyboard focus. When fired the reference to the window is cleared.
    
    Specified by:
    
    setFormWrapWindow in interface FormComponent
    
    Parameters:
    
    parent - the window (usually the parent window of this component).
  - getHelpURL
```
public String getHelpURL()
```
    Description copied from interface: FormComponent
    
    Gets the online-help URL.
    
    Specified by:
    
    getHelpURL in interface FormComponent
    
    Returns:
    
    the help url, default is null
  - setHelpURL
```
public void setHelpURL(String helpURL)
```
    Description copied from interface: FormComponent
    
    Sets the online-help URL.
    If a help url is set for this component, a browser will be launched to show that url. If there is no url the next higher level container will determine the url, and so forth.
    
    Specified by:
    
    setHelpURL in interface FormComponent
    
    Parameters:
    
    helpURL - the help url
    
    See Also:
    
    FormUtilities.openHelpURL(Component)
  - showHelp
```
public void showHelp()
```
    Description copied from interface: FormComponent
    
    Displays online help for this component.
    Usually triggered by KeyEvent.VK_F1 or VK_HELP or a button. If help is not configured for this component, the parent's help is used.
    
    Specified by:
    
    showHelp in interface FormComponent
  - getParentWindow
```
public Window getParentWindow()
```
    Description copied from interface: FormComponent
    
    Gets the parent window of this component.
    
    Specified by:
    
    getParentWindow in interface FormComponent
    
    Returns:
    
    the parent window, null if none
  - invalidateParentInfo
```
public void invalidateParentInfo()
```
    Description copied from interface: FormComponent
    
    Invalidates all container-relevant (cached) information for the hierarchy of this component's parents.
    For optimization purposes.
    
    Specified by:
    
    invalidateParentInfo in interface FormComponent
  - wasTransferFocus
```
public boolean wasTransferFocus()
```
    Description copied from interface: FormComponent
    
    Returns whether this component lost the keyboard focus due to FormComponent.transferFocus().
    
    Specified by:
    
    wasTransferFocus in interface FormComponent
    
    Returns:
    
    true if focus lost due to transferFocus
  - wasTransferFocusBackward
```
public boolean wasTransferFocusBackward()
```
    Description copied from interface: FormComponent
    
    Returns whether this component lost the keyboard focus due to FormComponent.transferFocusBackward().
    
    Specified by:
    
    wasTransferFocusBackward in interface FormComponent
    
    Returns:
    
    true if focus lost due to transferFocusBackward
  - wasFocusGainedFromTransfer
```
public boolean wasFocusGainedFromTransfer()
```
    Description copied from interface: FormComponent
    
    Returns whether the keyboard focus was gained due to FormComponent.transferFocus() in the opposite component.
    
    Specified by:
    
    wasFocusGainedFromTransfer in interface FormComponent
    
    Returns:
    
    true if this component gained the focus from the logically previous component
    
    See Also:
    
    FormFocusTraversalPolicy
  - wasFocusGainedFromTransferBackward
```
public boolean wasFocusGainedFromTransferBackward()
```
    Description copied from interface: FormComponent
    
    Returns whether the keyboard focus was gained due to FormComponent.transferFocusBackward() in the opposite component.
    
    Specified by:
    
    wasFocusGainedFromTransferBackward in interface FormComponent
    
    Returns:
    
    true if this component gained the focus from the logically next component
    
    See Also:
    
    FormFocusTraversalPolicy
  - wasTransferFocusByEnter
```
public boolean wasTransferFocusByEnter()
```
    Description copied from interface: FormComponent
    
    Returns whether this component lost the keyboard focus due to KeyEvent.VK_ENTER.
    
    Specified by:
    
    wasTransferFocusByEnter in interface FormComponent
    
    Returns:
    
    true if pressing the Enter/Return key caused a focus lost
  - setCellEditorUsage
```
public void setCellEditorUsage(boolean flag)
```
    Description copied from interface: FormComponent
    
    Sets a hint that this component is used as a cell editor.
    Some components behave differently in tables than in forms, for example.
    
    Specified by:
    
    setCellEditorUsage in interface FormComponent
    
    Parameters:
    
    flag - true if component is a cell editor, false if not.
  - isCellEditorUsage
```
public boolean isCellEditorUsage()
```
    Description copied from interface: FormComponent
    
    Returns whether this component is used as a cell editor.
    
    Specified by:
    
    isCellEditorUsage in interface FormComponent
    
    Returns:
    
    true true if component is a cell editor, false if not.
  - setFormTraversable
```
public void setFormTraversable(boolean formTraversable)
```
    Description copied from interface: FormComponent
    
    Sets whether this component is form traversable or not, i.e. gets the focus or is skipped.
    
    Specified by:
    
    setFormTraversable in interface FormComponent
    
    Parameters:
    
    formTraversable - true if traversable, false if not
  - isFormTraversable
```
public boolean isFormTraversable()
```
    Description copied from interface: FormComponent
    
    Returns whether this component is form traversable or not.
    
    Specified by:
    
    isFormTraversable in interface FormComponent
    
    Returns:
    
    the focus traversable flag
  - setFocusTraversalGroup
```
public void setFocusTraversalGroup(FocusTraversalGroup group)
```
    Description copied from interface: FormComponent
    
    Sets the focus traversal group for this component.
    
    Specified by:
    
    setFocusTraversalGroup in interface FormComponent
    
    Parameters:
    
    group - the focus traversal group
  - getFocusTraversalGroup
```
public FocusTraversalGroup getFocusTraversalGroup()
```
    Description copied from interface: FormComponent
    
    Gets the focus traversal group for this component.
    
    Specified by:
    
    getFocusTraversalGroup in interface FormComponent
    
    Returns:
    
    the focus traversal group
  - setPropertyGroup
```
public void setPropertyGroup(PropertyGroup group)
```
    Description copied from interface: FormComponent
    
    Sets the property group for this component.
    
    Specified by:
    
    setPropertyGroup in interface FormComponent
    
    Parameters:
    
    group - the property group
  - getPropertyGroup
```
public PropertyGroup getPropertyGroup()
```
    Description copied from interface: FormComponent
    
    Gets the property group for this component.
    
    Specified by:
    
    getPropertyGroup in interface FormComponent
    
    Returns:
    
    the property group
  - setMandatory
```
public void setMandatory(boolean mandatory)
```
    Description copied from interface: FormComponent
    
    Sets the mandatory option.
    Mandatory fields are differently visualized. There is no further functional difference.
    
    Specified by:
    
    setMandatory in interface FormComponent
    
    Parameters:
    
    mandatory - true if mandatory
  - isMandatory
```
public boolean isMandatory()
```
    Description copied from interface: FormComponent
    
    Gets the mandatory option.
    
    Specified by:
    
    isMandatory in interface FormComponent
    
    Returns:
    
    true if mandatory
  - setComponentPath
```
public void setComponentPath(String componentPath)
```
    Description copied from interface: FormComponent
    
    Sets the component path.
    The path is <declaring-class-name>.<field-name>. Example "de.krake.invoicer.InvoicePanel.customerNumberField".
    Notice: the component path is set during binding.
    
    Specified by:
    
    setComponentPath in interface FormComponent
    
    Parameters:
    
    componentPath - the component path
  - getComponentPath
```
public String getComponentPath()
```
    Description copied from interface: FormComponent
    
    Gets the component path.
    
    Specified by:
    
    getComponentPath in interface FormComponent
    
    Returns:
    
    the component path, null if not bound
  - setBindingPath
```
public void setBindingPath(String bindingPath)
```
    Description copied from interface: FormComponent
    
    Sets the path to bind this component to.
    Usually the binding path will be determined from the components declared name. However, it can be set programatically as well.
    
    Specified by:
    
    setBindingPath in interface FormComponent
    
    Parameters:
    
    bindingPath - the binding path, for ex. "invoiceNumber", null if autobinding
    
    See Also:
    
    Binder
  - getBindingPath
```
public String getBindingPath()
```
    Description copied from interface: FormComponent
    
    Gets the binding path.
    
    Specified by:
    
    getBindingPath in interface FormComponent
    
    Returns:
    
    the field path, null if autobinding (default)
  - setBinding
```
public void setBinding(FormComponentBinding binding)
```
    Description copied from interface: FormComponent
    
    Sets the binding.
    
    Specified by:
    
    setBinding in interface FormComponent
    
    Parameters:
    
    binding - the binding, null if none.
  - getBinding
```
public FormComponentBinding getBinding()
```
    Description copied from interface: FormComponent
    
    Gets the binding.
    
    Specified by:
    
    getBinding in interface FormComponent
    
    Returns:
    
    the binding, null if none
  - setBindable
```
public void setBindable(boolean bindable)
```
    Description copied from interface: FormComponent
    
    Sets whether this component is bindable.
    FormComponents are bindable by default.
    
    Specified by:
    
    setBindable in interface FormComponent
    
    Parameters:
    
    bindable - true if bindable, else not eligible for the binding process
  - isBindable
```
public boolean isBindable()
```
    Description copied from interface: FormComponent
    
    Determines whether this component is bindable.
    
    Specified by:
    
    isBindable in interface FormComponent
    
    Returns:
    
    true if bindable, else not eligible for the binding process
  - setSmartValueEntered
```
public void setSmartValueEntered(boolean smartValueEntered)
```
    Description copied from interface: FormComponent
    
    Sets whether the model should only be updated if the component's value really changed.
    The default is true.
    
    Specified by:
    
    setSmartValueEntered in interface FormComponent
    
    Parameters:
    
    smartValueEntered - true if optimize, false if always update the model
  - isSmartValueEntered
```
public boolean isSmartValueEntered()
```
    Description copied from interface: FormComponent
    
    Returns whether the model should only be updated if the component's value really changed.
    The default is true.
    
    Specified by:
    
    isSmartValueEntered in interface FormComponent
    
    Returns:
    
    true if optimize, false if always update the model
  - getValueShown
```
public Boolean getValueShown()
```
    Description copied from interface: FormComponent
    
    Gets the value shown to the user.
    This is the visual representation, not necessarily the model's value. Used to implemement smartValueEntered.
    
    Specified by:
    
    getValueShown in interface FormComponent
    
    Returns:
    
    the value visible to the user
  - isValueShownModified
```
public boolean isValueShownModified()
```
    Description copied from interface: FormComponent
    
    Checks whether the currently shown value differs from the initially shown.
    Used to implement smartValueEntered.
    
    Specified by:
    
    isValueShownModified in interface FormComponent
    
    Returns:
    
    true if user changed the visual representation
  - clearValueShownModified
```
public void clearValueShownModified()
```
    Description copied from interface: FormComponent
    
    Clears the value shown status.
    May be used by components that update the value shown programmatically.
    
    Specified by:
    
    clearValueShownModified in interface FormComponent

Class FormCheckBox

Nested Class Summary

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

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

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JCheckBox

Fields inherited from class javax.swing.AbstractButton

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.SwingConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JCheckBox

Methods inherited from class javax.swing.AbstractButton

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface org.tentackle.swing.FormComponent

Constructor Detail

FormCheckBox

FormCheckBox

FormCheckBox

FormCheckBox

Method Detail

showErrorPopup

getSelectedColor

setSelectedColor

getUnselectedColor

setUnselectedColor

setAutoUpdate

isAutoUpdate

getToolTipText

transferFocus

transferFocusBackward

processKeyEvent

processFocusEvent

requestFocusLater

actionPerformed

addValueListener

removeValueListener

fireValueChanged

fireValueEntered

setFormValue

getFormValue

saveValue

isValueChanged

setTriggerValueChangedEnabled

isTriggerValueChangedEnabled

triggerValueChanged

setChangeable

isChangeable

setHonourChangeable

isHonourChangeable

updateAllChangeable

setEnabled

setFireRunning

isFireRunning

prepareFocusLost

setFormWrapWindow

getHelpURL

setHelpURL

showHelp

getParentWindow

invalidateParentInfo

wasTransferFocus

wasTransferFocusBackward

wasFocusGainedFromTransfer

wasFocusGainedFromTransferBackward

wasTransferFocusByEnter

setCellEditorUsage

isCellEditorUsage

setFormTraversable

isFormTraversable

setFocusTraversalGroup