lumis.doui.control.optionlist
Class OptionListControl

Package class diagram package OptionListControl
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.optionlist.OptionListControl
All Implemented Interfaces:
Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

public class OptionListControl
extends DataBoundControl<TabularSource<?>>

Control to render a list of options. The options may be single selection (radio buttons) or multiple selection (checkbox). Each option is a row from the control source.


Field Summary
static int OPTION_TYPE_MULTIPLE_SELECTION
           
static int OPTION_TYPE_SINGLE_SELECTION
           
protected  int optionType
           
 
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_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
OptionListControl()
           
 
Method Summary
protected  Class<?> getValueClass()
          Returns the class the possible values of this control are assignable to.
 void init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
           
 void loadFromRequest()
           
 void setRenderData()
           
 boolean valueIsArray()
          Returns true if the value in the control is expected to be an array.
 
Methods inherited from class lumis.doui.control.DataBoundControl
autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, buildSubControls, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getUnboundedConverter, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, setValid, setValueFromSource, setValueFromSource, update
 
Methods inherited from class lumis.doui.control.DataControl
convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValue, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, 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.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

OPTION_TYPE_SINGLE_SELECTION

public static final int OPTION_TYPE_SINGLE_SELECTION
See Also:
Constant Field Values

OPTION_TYPE_MULTIPLE_SELECTION

public static final int OPTION_TYPE_MULTIPLE_SELECTION
See Also:
Constant Field Values

optionType

protected int optionType
Constructor Detail

OptionListControl

public OptionListControl()
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

loadFromRequest

public void loadFromRequest()
                     throws PortalException
Specified by:
loadFromRequest in interface IDataControl
Overrides:
loadFromRequest in class DataBoundControl<TabularSource<?>>
Throws:
PortalException

valueIsArray

public boolean valueIsArray()
                     throws PortalException
Description copied from class: DataControl
Returns true if the value in the control is expected to be an array.

Overrides:
valueIsArray in class DataControl
Returns:
Throws:
PortalException

getValueClass

protected Class<?> getValueClass()
                          throws PortalException
Description copied from class: DataControl
Returns the class the possible values of this control are assignable to.

This default implementation uses IDouiDataType.getValueClass() of the data type of this control.

Overrides:
getValueClass in class DataControl
Returns:
the class the possible values of this control are assignable to.
Throws:
PortalException

setRenderData

public void setRenderData()
                   throws PortalException
Specified by:
setRenderData in interface IControl
Overrides:
setRenderData in class DataBoundControl<TabularSource<?>>
Throws:
PortalException


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.