Package lumis.doui.control.checkbox

Class CheckBoxListControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl<TabularSource<?>>

lumis.doui.control.checkbox.CheckBoxListControl

All Implemented Interfaces:

java.util.Observer, javax.servlet.jsp.el.VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

public class CheckBoxListControl
extends DataBoundControl<TabularSource<?>>

Used to render a list of check boxes to allow the user to choose one or more of a given set of options. This control generally has two sources specified. One that returns/sets the value of the control and another that returns a list of options. The options may be optionally be explicitly provided within the control.

Example use: <control:lum_checkBoxList id="categories2" dataId="categoryId" sourceId="categorySubscription" optionsSourceId="category" /> xml data available for xsl rendering: <control dataId="categoryId" id="categories" optionsSourceId="category" sourceId="modelCategory" type="lum_checkBoxList"> <data> <option> <text>Category A</text> <value>8A488A031108C9AE0111098E417C095A</value> </option> </data> </control> Control that renders a list of check boxes

Since:

4.0.6

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
protected Source	optionsSource

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
CheckBoxListControl()

Method Summary

Modifier and Type	Method	Description
void	buildSubControls()
protected boolean	fixedIdentifierRequired()
void	init(org.w3c.dom.Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
void	setRenderData()
protected void	setValueFromSource()

Methods inherited from class lumis.doui.control.DataBoundControl

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

Methods inherited from class lumis.doui.control.DataControl

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

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, 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, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Field Detail

optionsSource

protected Source optionsSource

Constructor Detail

CheckBoxListControl

public CheckBoxListControl()

Method Detail

init

public void init(org.w3c.dom.Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException

Specified by:

init in interface IControl

Overrides:

init in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

fixedIdentifierRequired

protected boolean fixedIdentifierRequired()

Overrides:

fixedIdentifierRequired in class Control

setValueFromSource

protected void setValueFromSource()
                           throws PortalException

Overrides:

setValueFromSource in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl<TabularSource<?>>

Throws:

PortalException