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

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Button
              extended by com.ibm.commons.swt.controls.custom.CustomRadioButton
                  extended by com.ibm.commons.swt.data.controls.DCRadioButton
All Implemented Interfaces:
ICustomControl, IDataControl, IDataFieldControl, org.eclipse.swt.graphics.Drawable

public class DCRadioButton
extends CustomRadioButton
implements IDataFieldControl

Radio button control which can be bound to data.


Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Control
handle
 
Constructor Summary
DCRadioButton(org.eclipse.swt.widgets.Composite parent, int style, java.lang.String id)
          Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this 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 DCRadioButton control
 DataNode getDataNode()
          Returns the DataNode associated with this control.
 boolean getDefaultValue()
          Returns the default value of the radio button (on/off).
 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 selected.
 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 radio button (on/off).
 
Methods inherited from class com.ibm.commons.swt.controls.custom.CustomRadioButton
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

DCRadioButton

public DCRadioButton(org.eclipse.swt.widgets.Composite parent,
                     int style,
                     java.lang.String id)
Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Parameters:
parent - a Composite control which will be the parent of the new instance (CANNOT be null).
style - the style of the control to construct.
id - the programmatic ID of the control once constructed.
Method Detail

getControl

public org.eclipse.swt.widgets.Control getControl()
Returns the control which is bound to the Data, in this case the DCRadioButton 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 radio button is selected 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 selected. That is to say when the radio button is selected it sets a value in the related model. The value that is set is determined by the argument passed into this method.

Parameters:
checkedValue - - String
A string value representing the checked value of this checkbox.

checkSubclass

protected void checkSubclass()
Overrides:
checkSubclass in class CustomRadioButton

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 radio button (on/off).

Parameters:
value - - boolean

getDefaultValue

public boolean getDefaultValue()
Returns the default value of the radio button (on/off).

Returns: