lumis.doui.control.checkbox
Class CheckBoxListControl

Package class diagram package CheckBoxListControl
java.lang.Object
  extended by lumis.doui.control.Control
      extended by lumis.doui.control.DataControl
          extended by lumis.doui.control.DataBoundControl<TabularSource<?>>
              extended by lumis.doui.control.checkbox.CheckBoxListControl
All Implemented Interfaces:
Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

public class CheckBoxListControl
extends DataBoundControl<TabularSource<?>>
implements IClientSideReadableControl

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

Field Summary
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, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
CheckBoxListControl()
           
 
Method Summary
 void buildSubControls()
           
protected  boolean fixedIdentifierRequired()
           
 void init(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, getRuntimeDefaultSource, getSource, getSourceById, getUnboundedConverter, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, 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, setTrim, setValue, valueIsArray
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getStringsToLocalize, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, 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.IClientSideReadableControl
getScriptGetValues, getScriptGetValuesRegistration
 
Methods inherited from interface lumis.doui.control.IDataControl
getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue
 
Methods inherited from interface lumis.doui.control.IControl
createContainer, disconnect, getChildControls, getControlResource, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes
 
Methods inherited from interface lumis.doui.render.IRenderer
getResources, getSourceContext
 

Field Detail

optionsSource

protected Source optionsSource
Constructor Detail

CheckBoxListControl

public CheckBoxListControl()
Method Detail

init

public void init(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


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.