Package lumis.doui.control.checkbox

Class CheckBoxControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl

lumis.doui.control.checkbox.CheckBoxControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

DefaultPageTemplateControl, InterfaceInstanceInContextEditSupportControl

public class CheckBoxControl
extends DataBoundControl

Renders a checkbox control.

Example use: <control:lum_checkBox id="onlyOneVotePerUser" /> xml data available for xsl rendering: <control id="onlyOneVotePerUser" type="lum_checkBox"> <data> <value>false</value> </data> </control>

Since:

4.0.0

Version:

$Revision: 6166 $ $Date: 2007-03-16 15:29:00 -0300 (Fri, 16 Mar 2007) $

Field Summary

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
CheckBoxControl()

Method Summary

Modifier and Type	Method	Description
Object	getValue()	A check box control with a null value returns a false boolean as its value.
void	setRenderData()
void	setValue(Object value)	The check box control treats the String "1" value as a true boolean.

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, buildSubControls, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRequestHelpDefinition, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, init, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setSourceParameter, setSourceParameters, setTrim, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getStringsToLocalize, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getControlResource, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, setProcessActionHandlerParameters

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Constructor Detail

CheckBoxControl

public CheckBoxControl()

Method Detail

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getValue

public Object getValue()
                throws PortalException

A check box control with a null value returns a false boolean as its value.

Specified by:

getValue in interface IDataControl

Overrides:

getValue in class DataControl

Throws:

PortalException

Since:

4.0.4

setValue

public void setValue(Object value)
              throws PortalException

The check box control treats the String "1" value as a true boolean.

Specified by:

setValue in interface IDataControl

Overrides:

setValue in class DataControl

Parameters:

value - the value to set. It is automatically converted as necessary.

Throws:

PortalException

Since:

4.0.4