xdev.ui

Class XdevCheckBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

javax.swing.JCheckBox

xdev.ui.XdevCheckBox

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants, BooleanFormularComponent<XdevCheckBox>, FormularComponent<XdevCheckBox>, XdevFocusCycleComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevCheckBox
extends JCheckBox
implements BooleanFormularComponent<XdevCheckBox>, XdevFocusCycleComponent

The check box in XDEV. Based on JCheckBox.

Since:

2.0

Author:

XDEV Software

See Also:

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

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

FormularComponent.ValueChangeListener

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 xdev.ui.FormularComponent

DATA_FIELD_SEPARATOR

Fields inherited from interface xdev.ui.XdevFocusCycleComponent

TAB_INDEX_PROPERTY

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
XdevCheckBox()
XdevCheckBox(Action a)
XdevCheckBox(Icon icon)
XdevCheckBox(Icon icon, boolean selected)
XdevCheckBox(String text)
XdevCheckBox(String text, boolean selected)
XdevCheckBox(String text, Icon icon)
XdevCheckBox(String text, Icon icon, boolean selected)

Method Summary

Modifier and Type	Method and Description
void	addValidator(Validator validator) Adds a validator to this component
void	addValueChangeListener(FormularComponent.ValueChangeListener l) Registers a FormularComponent.ValueChangeListener.
boolean	getBoolean() Returns the value of this BooleanFormularComponent.
String	getDataField() Returns the name of the bound data field of this formular component.
String	getFalseReturnValue()
Operator	getFilterOperator() Returns the operator used in Formular.createCondition(String)
String	getFormularName() Returns the name of the component in the formular context.
Object	getFormularValue() Returns the value of the component.
String	getFormularValueList()
String	getReturnValue(boolean selected)
int	getTabIndex() Returns the tabindex assigned to this component.
String	getTrueReturnValue()
Validator[]	getValidators() Returns all validators of this component.
boolean	hasStateChanged() Checks if the component's state since the last call of FormularComponent.saveState() has changed.
boolean	isMultiSelect() Returns whether the component supports multi selection or not.
boolean	isReadOnly() Determines whether this component is only used to display values.
void	removeValidator(Validator validator) Removes a validator from this component
void	restoreState() Restores the internally saved state of the component.
void	saveState() Saves the state of the component internally.
void	setBoolean(boolean value) Sets the new value for this component.
void	setDataField(String dataField) Sets the name of the bound data field of this formular component.
void	setFalseReturnValue(String falseReturnValue)
void	setFilterOperator(Operator filterOperator) Sets the filter operator used in Formular.createCondition(String)
void	setFormularValue(VirtualTable vt, int col, Object value) Deprecated.
void	setFormularValue(VirtualTable vt, Map<String,Object> record) Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().
void	setFormularValueList(String formularValueList)
void	setReadOnly(boolean readOnly) Sets if this form component is only used to display values.
void	setReturnValue(boolean selected, String value)
void	setTabIndex(int tabIndex) Sets the tabindex of this component.
void	setTrueReturnValue(String trueReturnValue)
String	toString()
void	validateState() Calls Validator.validate(Object) of all registered Validators.
void	validateState(Validation validation) Calls Validator.validate(Object) of all registered Validators.
boolean	verify() Returns whether the component's value adheres all set constraints.

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, 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, 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, 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, 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, processFocusEvent, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.ui.FormularComponent

getClientProperty, isEnabled, isVisible, putClientProperty

Constructor Detail

XdevCheckBox

public XdevCheckBox()

XdevCheckBox

public XdevCheckBox(Action a)

XdevCheckBox

public XdevCheckBox(Icon icon,
                    boolean selected)

XdevCheckBox

public XdevCheckBox(Icon icon)

XdevCheckBox

public XdevCheckBox(String text,
                    boolean selected)

XdevCheckBox

public XdevCheckBox(String text,
                    Icon icon,
                    boolean selected)

XdevCheckBox

public XdevCheckBox(String text,
                    Icon icon)

XdevCheckBox

public XdevCheckBox(String text)

Method Detail

getFormularName

public String getFormularName()

Returns the name of the component in the formular context.

Specified by:

getFormularName in interface FormularComponent<XdevCheckBox>

Returns:

the name of the component in the formular context.

setDataField

public void setDataField(String dataField)

Sets the name of the bound data field of this formular component.

Specified by:

setDataField in interface FormularComponent<XdevCheckBox>

Parameters:

dataField - the new bound data field

Since:

3.1

getDataField

public String getDataField()

Returns the name of the bound data field of this formular component.

Specified by:

getDataField in interface FormularComponent<XdevCheckBox>

Returns:

the name of the bound data field

Since:

3.1

setFormularValue

@Deprecated
public final void setFormularValue(VirtualTable vt,
                                               int col,
                                               Object value)

Deprecated.

Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.

Specified by:

setFormularValue in interface FormularComponent<XdevCheckBox>

Parameters:

vt - VirtualTable to use the format from

col - of the column to use the format from

value - value to set

setFormularValue

public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)

Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().

Specified by:

setFormularValue in interface FormularComponent<XdevCheckBox>

Parameters:

vt - the underlying virtual table

record - the data <column,value>

Since:

3.2

getFormularValue

public Object getFormularValue()

Returns the value of the component.

Specified by:

getFormularValue in interface FormularComponent<XdevCheckBox>

Returns:

the value of the component.

saveState

public void saveState()

Saves the state of the component internally.

A saved state can be restored using FormularComponent.restoreState().

Specified by:

saveState in interface FormularComponent<XdevCheckBox>

restoreState

public void restoreState()

Restores the internally saved state of the component.

The state of the component can be saved using FormularComponent.saveState().

Specified by:

restoreState in interface FormularComponent<XdevCheckBox>

hasStateChanged

public boolean hasStateChanged()

Checks if the component's state since the last call of FormularComponent.saveState() has changed.

Specified by:

hasStateChanged in interface FormularComponent<XdevCheckBox>

Returns:

true if the component's state has changed, false otherwise

Since:

3.1

addValueChangeListener

public void addValueChangeListener(FormularComponent.ValueChangeListener l)

Registers a FormularComponent.ValueChangeListener.

Specified by:

addValueChangeListener in interface FormularComponent<XdevCheckBox>

Parameters:

l - the listener to register

Since:

3.1

isMultiSelect

public boolean isMultiSelect()

Returns whether the component supports multi selection or not.

A component that supports multi selection can have more than one selected item / value.

Specified by:

isMultiSelect in interface FormularComponent<XdevCheckBox>

Returns:

true if the component supports multi selection, false otherwise.

verify

public boolean verify()

Returns whether the component's value adheres all set constraints.

This is a alternative method for FormularComponent.validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.

Specified by:

verify in interface FormularComponent<XdevCheckBox>

Returns:

true if the value of the component adheres all set constraints; otherwise false.

addValidator

public void addValidator(Validator validator)

Adds a validator to this component

Specified by:

addValidator in interface FormularComponent<XdevCheckBox>

Parameters:

validator - the validator to add

Since:

3.1

See Also:

FormularComponent.validateState()

removeValidator

public void removeValidator(Validator validator)

Removes a validator from this component

Specified by:

removeValidator in interface FormularComponent<XdevCheckBox>

Parameters:

validator - the validator to remove

Since:

3.1

See Also:

FormularComponent.validateState()

getValidators

public Validator[] getValidators()

Returns all validators of this component.

If no validator is present an empty array is returned.

Specified by:

getValidators in interface FormularComponent<XdevCheckBox>

Returns:

all validators of this component

Since:

3.1

validateState

public void validateState()
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Specified by:

validateState in interface FormularComponent<XdevCheckBox>

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

validateState

public void validateState(Validation validation)
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.

Specified by:

validateState in interface FormularComponent<XdevCheckBox>

Parameters:

validation - the validation process object

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

setFilterOperator

public void setFilterOperator(Operator filterOperator)

Sets the filter operator used in Formular.createCondition(String)

Specified by:

setFilterOperator in interface FormularComponent<XdevCheckBox>

Parameters:

filterOperator - the new filter operator

Since:

3.1

getFilterOperator

public Operator getFilterOperator()

Returns the operator used in Formular.createCondition(String)

Specified by:

getFilterOperator in interface FormularComponent<XdevCheckBox>

Returns:

the component's filter operator

Since:

3.1

setReadOnly

public void setReadOnly(boolean readOnly)

Sets if this form component is only used to display values.

Specified by:

setReadOnly in interface FormularComponent<XdevCheckBox>

Parameters:

readOnly - true to only display values

Since:

3.2

isReadOnly

public boolean isReadOnly()

Determines whether this component is only used to display values.

Specified by:

isReadOnly in interface FormularComponent<XdevCheckBox>

Returns:

true if this component is only used to display values.

Since:

3.2

setFormularValueList

public void setFormularValueList(String formularValueList)

getFormularValueList

public String getFormularValueList()

setReturnValue

public void setReturnValue(boolean selected,
                           String value)

setTrueReturnValue

public void setTrueReturnValue(String trueReturnValue)

setFalseReturnValue

public void setFalseReturnValue(String falseReturnValue)

getReturnValue

public String getReturnValue(boolean selected)

getTrueReturnValue

public String getTrueReturnValue()

getFalseReturnValue

public String getFalseReturnValue()

getBoolean

public boolean getBoolean()

Returns the value of this BooleanFormularComponent.

Specified by:

getBoolean in interface BooleanFormularComponent<XdevCheckBox>

Returns:

the value of this component

Since:

3.1

setBoolean

public void setBoolean(boolean value)

Sets the new value for this component.

Specified by:

setBoolean in interface BooleanFormularComponent<XdevCheckBox>

Parameters:

value - true or false

Since:

3.1

toString

public String toString()

Overrides:

toString in class Component

getTabIndex

public int getTabIndex()

Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.

Specified by:

getTabIndex in interface XdevFocusCycleComponent

Returns:

tabindex of this component

setTabIndex

public void setTabIndex(int tabIndex)

Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.

To exclude this component from the focus cycle set tabindex to -1.

Specified by:

setTabIndex in interface XdevFocusCycleComponent

Parameters:

tabIndex - to be set