com.ibm.commons.swt.data.controls
Class DCCheckbox

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Button
              com.ibm.commons.swt.controls.custom.CustomCheckBox
                  com.ibm.commons.swt.data.controls.DCCheckbox

All Implemented Interfaces:

ICustomControl, IDataControl, IDataFieldControl, org.eclipse.swt.graphics.Drawable

public class DCCheckbox
extends CustomCheckBox
implements IDataFieldControl

A checkbox control which is bound to data. This control's value (true/false) is determined by the model associated with the control. During control initialization the model is found, and the attribute that this control is associated with is sought from the model. If the attribute exists in the model then the attribute's value is associated with this control.

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

DCCheckbox(org.eclipse.swt.widgets.Composite parent, int style)
Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control.

DCCheckbox(org.eclipse.swt.widgets.Composite parent, int style, java.lang.String id)
Constructs a new instance of the class given the parent Composite, the style flags which are used to set the look/behavior of the control, and an id property that can be used to programatically identify the control.

Method Summary

protected void	checkSubclass()
java.lang.String	getAttributeName() Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl Returns the name of the attribute that the control is associated with, may be null.
java.lang.String	getCheckedValue() Returns the value that this control sets in the model when the control is 'checked'.
org.eclipse.swt.widgets.Control	getControl() Returns the control which is bound to the Data, in this case the Checkbox control
DataNode	getDataNode() Returns the DataNode associated with this control.
boolean	getDefaultValue() Returns the default state of the checkbox
java.lang.String	getUncheckedValue() Returns the value that this control sets in the model when the control is 'unchecked'.
java.lang.String	getValue() Returns the value of the checkbox.
boolean	isMultiSel() Returns whether the current checkbox should be disabled if its value in the associated model is neither the checked or unchecked control values.
void	setAttributeName(java.lang.String attributeName) Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl Sets the name of the attribute that the control is associated with.
void	setCheckedValue(java.lang.String checkedValue) Sets the value that this control sets in the model when the control is 'checked'.
void	setDataNode(DataNode dataNode) Sets the DataNode associated with this control.
void	setDataNodeBinding(DataNodeBinding dataNodeBinding)
void	setDefaultValue(boolean value) Sets the default value of the control
void	setMultiSel(boolean multiSel) Determines if the current checkbox should be disabled if its value in the associated model is neither the checked or unchecked control values.
void	setUncheckedValue(java.lang.String uncheckedValue) Sets the value that this control sets in the model when the control is 'unchecked'.
void	setValue(java.lang.String value) Sets the value of the checkbox.

Methods inherited from class com.ibm.commons.swt.controls.custom.CustomCheckBox

getId, setId

Methods inherited from class org.eclipse.swt.widgets.Button

addSelectionListener, computeSize, getAlignment, getGrayed, getImage, getSelection, getText, removeSelectionListener, setAlignment, setGrayed, setImage, setSelection, setText

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DCCheckbox

public DCCheckbox(org.eclipse.swt.widgets.Composite parent,
                  int style)

Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. Style bits are also inherited from superclasses.

Parameters:

parent - a Composite control which will be the parent of the new instance (CANNOT be null).

style - the style of control to construct

DCCheckbox

public DCCheckbox(org.eclipse.swt.widgets.Composite parent,
                  int style,
                  java.lang.String id)

Constructs a new instance of the class given the parent Composite, the style flags which are used to set the look/behavior of the control, and an id property that can be used to programatically identify the control.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. Style bits are also inherited from superclasses.

Parameters:

parent - a Composite control which will be the parent of the new instance (CANNOT be null).

style - the style of control to construct

id - a String which can be used to programatically identify the control

Method Detail

getControl

public org.eclipse.swt.widgets.Control getControl()

Returns the control which is bound to the Data, in this case the Checkbox control

Specified by:

getControl in interface IDataControl

Returns:

getCheckedValue

public java.lang.String getCheckedValue()

Returns the value that this control sets in the model when the control is 'checked'. That is to say when the check box is checked it sets a value in the related model. The value that is set is determined by the return value of this method.
The default value is "true".

Returns:

A String value that represents the checked value of the control

setCheckedValue

public void setCheckedValue(java.lang.String checkedValue)

Sets the value that this control sets in the model when the control is 'checked'. That is to say when the check box is checked it sets a value in the related model. The value that is set is determined by the argument passed into this method.

Parameters:

checkedValue - a string value representing the checked value of this checkbox.

getUncheckedValue

public java.lang.String getUncheckedValue()

Returns the value that this control sets in the model when the control is 'unchecked'. That is to say when the check box is not checked it sets a value in the related model. The value that is set is determined by the return value of this method.
The default value is "false".

Returns:

a String value that represents the unchecked value of the control

setUncheckedValue

public void setUncheckedValue(java.lang.String uncheckedValue)

Sets the value that this control sets in the model when the control is 'unchecked'. That is to say when the check box is not checked it sets a value in the related model. The value that is set is determined by the argument passed into this method.

Parameters:

uncheckedValue - a string value representing the unchecked value of this checkbox.

setMultiSel

public void setMultiSel(boolean multiSel)

Determines if the current checkbox should be disabled if its value in the associated model is neither the checked or unchecked control values. That is to say if the value in the model is neither true nor false (for the default case) then the checkbox is disabled. The default value for this property is "false".

Parameters:

multiSel -

isMultiSel

public boolean isMultiSel()

Returns whether the current checkbox should be disabled if its value in the associated model is neither the checked or unchecked control values. That is to say if the value in the model is neither true nor false (for the default case) then the checkbox is disabled. The default value for this property is "false".

Returns:

checkSubclass

protected void checkSubclass()

Overrides:

checkSubclass in class CustomCheckBox

getDataNode

public DataNode getDataNode()

Returns the DataNode associated with this control. The DataNode is responsible for providing the model through which the control accesses data.

Returns:

com.ibm.commons.iloader.node.DataNode

See Also:

DataNode

setDataNode

public void setDataNode(DataNode dataNode)

Sets the DataNode associated with this control. The DataNode is responsible for providing the model through which the control accesses data.

See Also:

DataNode

setDataNodeBinding

public void setDataNodeBinding(DataNodeBinding dataNodeBinding)

Parameters:

dataNodeBinding -

See Also:

DataNodeBinding

getAttributeName

public java.lang.String getAttributeName()

Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl
Returns the name of the attribute that the control is associated with, may be null.

Specified by:

getAttributeName in interface IDataFieldControl

Returns:

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl
Sets the name of the attribute that the control is associated with.

Specified by:

setAttributeName in interface IDataFieldControl

Parameters:

attributeName -

setDefaultValue

public void setDefaultValue(boolean value)

Sets the default value of the control

Parameters:

value -

getDefaultValue

public boolean getDefaultValue()

Returns the default state of the checkbox

Returns:

setValue

public void setValue(java.lang.String value)

Sets the value of the checkbox. A string value is used here as the control may have a non boolean checked value or unchecked value.

Parameters:

value -

getValue

public java.lang.String getValue()

Returns the value of the checkbox. A string value is used here as the control may have a non boolean checked value or unchecked value.

Returns: