Package lumis.doui.control.itempicker
Class ItemPickerControl
- java.lang.Object
-
- lumis.doui.control.Control
-
- lumis.doui.control.DataControl
-
- lumis.doui.control.DataBoundControl
-
- lumis.doui.control.itempicker.ItemPickerControl
-
- All Implemented Interfaces:
Observer
,VariableResolver
,IControl
,IDataBoundControl
,IDataControl
,IRenderer
public class ItemPickerControl extends DataBoundControl
Used to select an item from a large list.
This control contains three significant properties. The id of the field that it represents, the id of that field that represents a user friendly name for the field that it represents and finally an interface that is responsible for searching and selecting the item.
The control renders a readonly user friendly name with a selection and clear icon beside it. When the user selects the selection icon the specified search interface is popped passing the javascript function name that should be called to update the identifier and friendly name of this control.
Example use:lumis.service.sample.selectusingsearch.selectUser
xml data available for xsl rendering:lumis.service.sample.selectusingsearch.selectUser 00000000D00000000000000000000004 LumisPageCacheUser - Since:
- 4.1.0
- Version:
- $Revision: 20605 $ $Date: 2017-10-10 17:07:21 -0300 (Tue, 10 Oct 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 ItemPickerControl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
autoAddValidators()
void
buildSubControls()
IResource
getControlResource()
String
getDisplayDataId()
protected IServiceInterfaceUrl
getPopupUrl()
String
getSearchInterfaceId()
protected String
getSelectScriptFunctionName()
Returns the select script function name.protected Map<String,String>
getStringsToLocalize()
void
init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void
loadFromRequest()
void
setDisplayDataId(String displayField)
void
setRenderData()
void
setSearchInterfaceId(String searchInterfaceId)
protected void
setValueFromSource()
-
Methods inherited from class lumis.doui.control.DataBoundControl
autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, 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, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, 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, 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
-
-
-
-
Method Detail
-
init
public void init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl) throws PortalException
- Specified by:
init
in interfaceIControl
- Overrides:
init
in classDataBoundControl
- Throws:
PortalException
-
buildSubControls
public void buildSubControls() throws PortalException
- Specified by:
buildSubControls
in interfaceIControl
- Overrides:
buildSubControls
in classDataBoundControl
- Throws:
PortalException
-
loadFromRequest
public void loadFromRequest() throws PortalException
- Specified by:
loadFromRequest
in interfaceIDataControl
- Overrides:
loadFromRequest
in classDataBoundControl
- Throws:
PortalException
-
setValueFromSource
protected void setValueFromSource() throws PortalException
- Overrides:
setValueFromSource
in classDataBoundControl
- Throws:
PortalException
-
setRenderData
public void setRenderData() throws PortalException
- Specified by:
setRenderData
in interfaceIControl
- Overrides:
setRenderData
in classDataBoundControl
- Throws:
PortalException
-
getPopupUrl
protected IServiceInterfaceUrl getPopupUrl() throws PortalException
- Throws:
PortalException
-
getSelectScriptFunctionName
protected String getSelectScriptFunctionName()
Returns the select script function name.- Returns:
- the select script function name.
- Since:
- 7.0.0
-
getDisplayDataId
public String getDisplayDataId()
-
setDisplayDataId
public void setDisplayDataId(String displayField)
-
getSearchInterfaceId
public String getSearchInterfaceId()
-
setSearchInterfaceId
public void setSearchInterfaceId(String searchInterfaceId)
-
autoAddValidators
protected void autoAddValidators() throws PortalException
- Overrides:
autoAddValidators
in classDataBoundControl
- Throws:
PortalException
-
getStringsToLocalize
protected Map<String,String> getStringsToLocalize()
- Overrides:
getStringsToLocalize
in classControl
-
getControlResource
public IResource getControlResource() throws PortalException
- Specified by:
getControlResource
in interfaceIControl
- Overrides:
getControlResource
in classControl
- Throws:
PortalException
-
-