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

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  com.ibm.commons.swt.controls.custom.CustomComposite
                      com.ibm.commons.swt.data.editors.api.CompositeEditor
                          com.ibm.commons.swt.data.controls.DCCompositeEditor
                              com.ibm.commons.swt.data.controls.DCCompositeCheckbox

All Implemented Interfaces:

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

public class DCCompositeCheckbox
extends DCCompositeEditor

Checkbox control binded to data.

Field Summary

Fields inherited from class com.ibm.commons.swt.data.editors.api.CompositeEditor

cmptdDialogButton, COMPUTED_IMG, COMPUTED_IMG_HC, COMPUTED_IMG_HOVER, COMPUTED_IMG_HOVER_HC, control, CUSTOM_EDITOR_IMG, CUSTOM_EDITOR_IMG_HC, delButton, dialogButton, extraLabel, IMG_BROWSEBUTTON, IMG_BROWSEBUTTON_HC, IMG_COMPUTED, IMG_VALUEBINDING, label, menuButton, NON_COMPUTED_IMG, NON_COMPUTED_IMG_HC, NON_COMPUTED_IMG_HOVER, NON_COMPUTED_IMG_HOVER_HC, realControl, realDialogButton

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

handle

Constructor Summary

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

DCCompositeCheckbox(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

java.lang.String	getCheckedValue() Returns the value that this control sets in the model when the control is 'checked'.
boolean	getDefaultValue() Returns the default value of the checkbox (true/false).
java.lang.String	getText() Returns the text value of the checkbox button that this Composite Checkbox represents
java.lang.String	getUncheckedValue() Returns the value that this control sets in the model when the control is 'unchecked'.
void	setCheckedValue(java.lang.String checkedValue) Sets the value that this control sets in the model when the control is 'checked'.
void	setDefaultValue(boolean value) Sets the default value for the checkbox (true/false).
void	setScriptComputedMode(java.lang.String mode) Sets the scripting modes that can be used when computing the value of the attribute associated with this control.
void	setText(java.lang.String text) Sets the text (label) of the checkbox button
void	setToolTipText(java.lang.String string) Sets the tooltip text associated with the checkbox control
void	setUncheckedValue(java.lang.String uncheckedValue) Sets the value that this control sets in the model when the control is 'unchecked'.

Methods inherited from class com.ibm.commons.swt.data.controls.DCCompositeEditor

getAttributeName, getControl, getDataNode, getEditorOptions, getPropertyEditor, getPropertyEditorName, getPropertyEditorParameter, initEditor, setAttributeName, setDataNode, setDataNodeBinding, setPropertyEditor, setPropertyEditorName, setPropertyEditorParameter

Methods inherited from class com.ibm.commons.swt.data.editors.api.CompositeEditor

addCompositeChildrenListener, addListeners, addValueChangedListener, callDialog, callScriptDialog, checkBtnVisible, getComputedLabelString, getComputedLabelTooltip, getCurrentValueType, getEditor, getEditorControl, getLabel, getMenuButtonImage, getMenuButtonImageHover, getPropertyEditorScriptMode, getRealControl, getValue, handleDeleteButton, hasCmptdAccessBtn, hasMenuButton, initComputedLabel, initPropertyEditor, isCellEditor, isComputable, isPrimitiveCollectionItemNode, isPropertyEditorScriptModeFixed, postDisposeEditor, removeCompositeChildrenListener, removeValueChangedListener, setAccessibleListener, setEnabled, setHasCmptdAccessBtn, setHasMenuButton, setIsComputable, setLabel, setTraverseListener, setValue, showPopUpMenu, updateControls, updateValue

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

getId, getUpdater, setId, setUpdater

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

changed, checkSubclass, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

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

computeTrim, getBorderWidth, getClientArea, getHorizontalBar, getVerticalBar

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTouchEnabled, 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

DCCompositeCheckbox

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

Constructs a new instance of the class given the parent Composite, and the 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

DCCompositeCheckbox

public DCCompositeCheckbox(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

getText

public java.lang.String getText()

Returns the text value of the checkbox button that this Composite Checkbox represents

Returns:

String The text of the checbox button

setText

public void setText(java.lang.String text)

Sets the text (label) of the checkbox button

Parameters:

text -

setDefaultValue

public void setDefaultValue(boolean value)

Sets the default value for the checkbox (true/false).

Parameters:

value -

getDefaultValue

public boolean getDefaultValue()

Returns the default value of the checkbox (true/false).

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.

setScriptComputedMode

public void setScriptComputedMode(java.lang.String mode)

Sets the scripting modes that can be used when computing the value of the attribute associated with this control.

Parameters:

mode - - String
Is typically either of the following:

• com.ibm.designer.domino.scripting.IScriptContent.MODE_COMPUTED
• com.ibm.designer.domino.scripting.IScriptContent.MODE_VALUEBINDING

setToolTipText

public void setToolTipText(java.lang.String string)

Sets the tooltip text associated with the checkbox control

Overrides:

setToolTipText in class org.eclipse.swt.widgets.Control