Class MultiFileUploadControl
- java.lang.Object
-
- lumis.doui.control.Control
-
- lumis.doui.control.DataControl
-
- lumis.doui.control.DataBoundControl<TabularSource<ITabularSourceField>>
-
- lumis.doui.control.multifileupload.MultiFileUploadControl
-
- All Implemented Interfaces:
Observer
,VariableResolver
,IControl
,IDataBoundControl
,IDataControl
,IRenderer
@StableMinor(version="14.0", sinceVersion="6.1") public class MultiFileUploadControl extends DataBoundControl<TabularSource<ITabularSourceField>>
Control used to upload multiples files at same time.This control must have as dataId the value of source file field.
This control generates sub-controls needed to control all information added by users. This informations can not be changed by users. In addition it generate a validator subcontrol that checks if exists some upload in progress when the user perform a ProcessAction.
Example use:<control className="MultiFileUploadRequiredValueValidatorControl" type="lum_requiredValueValidator"> <script> script value </script> </control> <control id="imageFile_supportedType" trim="true" type="lum_inputHidden" value=""/> <control id="imageFile_addedGUIDs" trim="true" type="lum_inputHidden" value="" /> <control id="imageFile_folderId" trim="true" type="lum_inputHidden" value="8A488A28315CB65C01315DD0977B37F5" /> <control id="imageFile_multiFileUploadListOfFilesAdded" trim="true" type="lum_inputHidden" value="" /> <control id="imageFile_numberOfAddedFiles" trim="true" type="lum_inputHidden" value="0"/> <control id="imageFile_renderAction" trim="true" type="lum_inputHidden" value="true" />
xml data available for xsl rendering:<control:lum_multiFileUpload id="imageFile" sourceId="sourceName" allowedFileExtensions="*.jpg;*.png;*.gif" dataId="dataId"> <buttons> <clearButton> <label>STR_LABEL</label> <image>imagePath</image> </clearButton> <deleteButton> <label>STR_LABEL</label> <image>imagePath</image> </deleteButton> <addButton> <label>STR_LABEL</label> <image>imagePath</image> </addButton> </buttons> <messages> <error>STR_MESSAGE</error> <success>STR_MESSAGE</success> </messages> <controls> <control:lum_inputText id="name" dataId="name" sourceId="none"/> </controls> </control:lum_multiFileUpload>
<control id="imageFile" type="lum_multiFileUpload" allowedFileExtensions="*.jpg;*.png;*.gif"> <!-- sub control --> <def> <clearButton> <label>Clear</label> <image>lumis/portal/client/images/Clear.gif</image> </clearButton> <deleteButton> <label>Delete</label> <image>lumis/portal/client/images/Delete.gif</image> </deleteButton> <addButton> <label>Add</label> <image>lumis/portal/client/images/Add.gif</image> </addButton> <messages> <error>STR_MESSAGE</error> <success>STR_MESSAGE</success> </messages> <sii>8A488A1B2C6595B5012C6596FC8A01B6</sii> <lumUserSessionId>8A488AF92CBBAF59012CBBD698420390</lumUserSessionId> <folder>8A488AF92CBBAF59012CBBE219450556</folder> <allowedFileExtensions /> <fileDescription /> </def> </control>
- Since:
- 6.1.0
- Version:
- $Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $
-
-
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, 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 MultiFileUploadControl()
Default constructor forMultiFileUploadControl
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildSubControls()
IResource
getControlResource()
protected String
getFileDescription(String allowedFileExtensions)
Returns the files description used on open file system window.IDataControlRequestHelpDefinition
getRequestHelpDefinition()
Returns the request parameters help definition.protected String
getUploadFolder()
Returns the folder where temporary uploads are stored.void
init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void
setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
Sets the control value as a process action handler parameter.void
setRenderData()
-
Methods inherited from class lumis.doui.control.DataBoundControl
autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, 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, 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, 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, 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
-
MultiFileUploadControl
public MultiFileUploadControl()
Default constructor forMultiFileUploadControl
.- Since:
- 6.1.0
-
-
Method Detail
-
getControlResource
public IResource getControlResource() throws PortalException
- Specified by:
getControlResource
in interfaceIControl
- Overrides:
getControlResource
in classControl
- 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 interfaceIDataControl
- Overrides:
setProcessActionHandlerParameters
in classDataControl
- Throws:
PortalException
-
init
public void init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl) throws PortalException
- Specified by:
init
in interfaceIControl
- Overrides:
init
in classDataBoundControl<TabularSource<ITabularSourceField>>
- Throws:
PortalException
-
buildSubControls
public void buildSubControls() throws PortalException
- Specified by:
buildSubControls
in interfaceIControl
- Overrides:
buildSubControls
in classDataBoundControl<TabularSource<ITabularSourceField>>
- Throws:
PortalException
-
setRenderData
public void setRenderData() throws PortalException
- Specified by:
setRenderData
in interfaceIControl
- Overrides:
setRenderData
in classDataBoundControl<TabularSource<ITabularSourceField>>
- Throws:
PortalException
-
getFileDescription
protected String getFileDescription(String allowedFileExtensions) throws PortalException
Returns the files description used on open file system window.- Parameters:
allowedFileExtensions
- allowed files extensions- Returns:
- the files description used on open file system window.
- Throws:
PortalException
- Since:
- 6.1.0
-
getUploadFolder
protected String getUploadFolder()
Returns the folder where temporary uploads are stored. This folder is relative to thePortalContext#getDataPath("upload")
.- Returns:
- the folder where temporary uploads are done
- Since:
- 6.1.0
-
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 interfaceIDataControl
- Overrides:
getRequestHelpDefinition
in classDataBoundControl<TabularSource<ITabularSourceField>>
- Returns:
- the request parameters help definition. Used in process action REST API help. Must not return null.
- Throws:
PortalException
-
-