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

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

All Implemented Interfaces:

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

public class DCToggleButton
extends CustomToggleButton
implements IDataFieldControl

A button whose toggle state (selected/not selected) is determined by a data model.

Field Summary

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

handle

Constructor Summary

DCToggleButton(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 used to determine if this button should be toggled to the on position.
org.eclipse.swt.widgets.Control	getControl() Returns the control which is bound to the Data, in this case the DCToggleButton control
DataNode	getDataNode() Returns the DataNode associated with this control.
java.lang.String	getUncheckedValue() Returns the value used to determine if this button should be toggled to the off position.
boolean	isRadioButton() Returns whether or not this button is a radio button.
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 is used to determine if this button should be toggled to the on position.
void	setDataNode(DataNode dataNode) Sets the DataNode associated with this control.
void	setDataNodeBinding(DataNodeBinding dataNodeBinding)
void	setRadioButton(boolean radioButton) Sets whether or not this control is a radio button.
void	setUncheckedValue(java.lang.String uncheckedValue) Sets the value that is used to determine if this button should be toggled to the off position.

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

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

DCToggleButton

public DCToggleButton(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 DCToggleButton control

Specified by:

getControl in interface IDataControl

Returns:

isRadioButton

public boolean isRadioButton()

Returns whether or not this button is a radio button.

Returns:

boolean

setRadioButton

public void setRadioButton(boolean radioButton)

Sets whether or not this control is a radio button.

Parameters:

radioButton -

getCheckedValue

public java.lang.String getCheckedValue()

Returns the value used to determine if this button should be toggled to the on position.

Returns:

String

setCheckedValue

public void setCheckedValue(java.lang.String checkedValue)

Sets the value that is used to determine if this button should be toggled to the on position.

Parameters:

checkedValue - - String

getUncheckedValue

public java.lang.String getUncheckedValue()

Returns the value used to determine if this button should be toggled to the off position.

Returns:

String

setUncheckedValue

public void setUncheckedValue(java.lang.String uncheckedValue)

Sets the value that is used to determine if this button should be toggled to the off position.

Parameters:

checkedValue - - String

checkSubclass

protected void checkSubclass()

Overrides:

checkSubclass in class CustomToggleButton

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 -