Package lumis.doui.control.itempicker

Class OrderedMultiItemPickerControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

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

lumis.doui.control.itempicker.OrderedMultiItemPickerControl

All Implemented Interfaces:

java.util.Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

public class OrderedMultiItemPickerControl
extends DataBoundControl<TabularSource<?>>

Ordered Multiple item picker control.

Allows the end user to add and remove multiple items. Currently used in themes and style autocomplete dropdownlist.
Example use:

<control type="lum_orderedMultiItemList" id="themeList" sourceId="channelTheme" name="STR_THEMES"> <itemListUrl>lumis/api/rest/lum-internal/admin/portal-studio/itempicker/theme/getthemelist</itemListUrl> </control>

Since:

7.1.0

Version:

$Revision: 20825 $ $Date: 2017-12-11 14:43:21 -0200 (Mon, 11 Dec 2017) $

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getItemKeyFieldId()
java.lang.String	getItemNameFieldId()
IDataControlRequestHelpDefinition	getRequestHelpDefinition()	Returns the request parameters help definition.
protected java.lang.Class<?>	getValueClass()	Returns the class the possible values of this control are assignable to.
void	init(org.w3c.dom.Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
void	setItemKeyFieldId(java.lang.String itemKeyFieldId)
void	setItemNameFieldId(java.lang.String itemNameFieldId)
void	setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)	Sets the control value as a process action handler parameter.
void	setRenderData()
protected void	setValueFromSource(TabularSource<?> source)	Reads the value corresponding to the current control from the control source.

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, 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, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setSourceParameter, setSourceParameters, setTrim, setValue, 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, getValue, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Constructor Detail

OrderedMultiItemPickerControl

public OrderedMultiItemPickerControl()

Method Detail

getValueClass

protected java.lang.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

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

getItemKeyFieldId

public java.lang.String getItemKeyFieldId()

setItemKeyFieldId

public void setItemKeyFieldId(java.lang.String itemKeyFieldId)

getItemNameFieldId

public java.lang.String getItemNameFieldId()

setItemNameFieldId

public void setItemNameFieldId(java.lang.String itemNameFieldId)

setValueFromSource

protected void setValueFromSource(TabularSource<?> source)
                           throws PortalException

Description copied from class: DataBoundControl

Reads the value corresponding to the current control from the control source. By default the value that is taken from the source is from the first row of the source tabular data. However, if the control has the dataRow specified, the value taken from the source tabular data corresponds to specified row.

Overrides:

setValueFromSource 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

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

setProcessActionHandlerParameters

public void setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
                                       throws PortalException

Description copied from class: DataControl

Sets the control value as a process action handler parameter.

Specified by:

setProcessActionHandlerParameters in interface IDataControl

Overrides:

setProcessActionHandlerParameters in class DataControl

Throws:

PortalException

getRequestHelpDefinition

public IDataControlRequestHelpDefinition getRequestHelpDefinition()
                                                           throws PortalException

Description copied from interface: IDataControl

Returns the request parameters help definition. Used in process action REST API help. Must not return null.

Specified by:

getRequestHelpDefinition in interface IDataControl

Overrides:

getRequestHelpDefinition in class DataBoundControl<TabularSource<?>>

Returns:

the request parameters help definition. Used in process action REST API help. Must not return null.

Throws:

PortalException