lumis.doui.control.dropdownlist
Class DropDownListControl

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.DataControl
          lumis.doui.control.DataBoundControl
              lumis.doui.control.dropdownlist.DropDownListControl

All Implemented Interfaces:

Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

ConsumerConfigurationInterfaceDropDownListControl, ProducerConfigurationInterfaceVersionDropDownListControl

public class DropDownListControl
extends DataBoundControl
implements IClientSideReadableControl

Used to render a drop down combo box control to allow the user to choose one 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_dropDownList id="emailFormat" sourceId="subscription" /> xml data available for xsl rendering: <control id="emailFormat" sourceId="subscription" type="lum_dropDownList"> <data> <option> <text /> <value /> </option> <option> <text>Text</text> <value>0</value> </option> <option> <text>HTML</text> <value>1</value> </option> </data> </control> A control that renders the possible input values in a dropdown for the user to select one.

Since:

4.0.0

Field Summary

protected int	OPTIONS_AFTER
protected int	OPTIONS_ALL
protected int	OPTIONS_BEFORE
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_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

DropDownListControl()

Method Summary

protected void	appendDefinitionOptions(StringBuilder results, int optionType)
protected void	autoAddValidators()
void	buildSubControls()
protected boolean	fixedIdentifierRequired()
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
void	setRenderData()

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, 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, 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

OPTIONS_ALL

protected final int OPTIONS_ALL

See Also:

Constant Field Values

OPTIONS_BEFORE

protected final int OPTIONS_BEFORE

See Also:

Constant Field Values

OPTIONS_AFTER

protected final int OPTIONS_AFTER

See Also:

Constant Field Values

optionsSource

protected Source optionsSource

Constructor Detail

DropDownListControl

public DropDownListControl()

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

Throws:

PortalException

fixedIdentifierRequired

protected boolean fixedIdentifierRequired()

Overrides:

fixedIdentifierRequired in class Control

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

appendDefinitionOptions

protected void appendDefinitionOptions(StringBuilder results,
                                       int optionType)
                                throws PortalException

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

autoAddValidators

protected void autoAddValidators()
                          throws PortalException

Overrides:

autoAddValidators in class DataBoundControl

Throws:

PortalException