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, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

public class ItemPickerControl
extends DataBoundControl
implements IClientSideReadableControl

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:

<control:lum_itemPicker id="userId" displayDataId="userName"> <searchInterfaceId>lumis.service.sample.selectusingsearch.selectUser</searchInterfaceId> </control:lum_itemPicker>
xml data available for xsl rendering: <control dataId="userId" displayDataId="userName" id="userId.userId" sourceId="default" type="lum_itemPicker"> <searchInterfaceId>lumis.service.sample.selectusingsearch.selectUser</searchInterfaceId> <control id="8A488A0F158A409701158A42522F0095" type="lum_requiredValueValidator" /> <data> <item> <id>00000000D00000000000000000000004</id> <displayString>LumisPageCacheUser</displayString> </item> <openPopupScript><!-- javascript for opening a pop to select an item --></openPopupScript> <selectItemFunction><!-- javascript function that is called by the pop to set the id and display name of the item selected --></selectItemFunction> <clearItemScript><!-- javascript to clear the id and name selected --></clearItemScript> </data> </control>

Since:

4.1.0

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_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

ItemPickerControl()

Method Summary

protected void	autoAddValidators()
void	buildSubControls()
String	getDisplayDataId()
protected IServiceInterfaceUrl	getPopupUrl()
String	getSearchInterfaceId()
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, 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, getRequestParameterName, getValue, getValue, getValueClass, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, 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, 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

Constructor Detail

ItemPickerControl

public ItemPickerControl()

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

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl

Throws:

PortalException

setValueFromSource

protected void setValueFromSource()
                           throws PortalException

Overrides:

setValueFromSource in class DataBoundControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getPopupUrl

protected IServiceInterfaceUrl getPopupUrl()
                                    throws PortalException

Throws:

PortalException

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 class DataBoundControl

Throws:

PortalException