lumis.doui.control.multifileupload
Class MultiFileUploadControl

Package class diagram package MultiFileUploadControl
java.lang.Object
  extended by lumis.doui.control.Control
      extended by lumis.doui.control.DataControl
          extended by lumis.doui.control.DataBoundControl<TabularSource<ITabularSourceField>>
              extended by lumis.doui.control.multifileupload.MultiFileUploadControl
All Implemented Interfaces:
Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

@StableMinor(version="6.2",
             sinceVersion="6.1")
public class MultiFileUploadControl
extends DataBoundControl<TabularSource<ITabularSourceField>>
implements IClientSideReadableControl

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.

 
 <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" />
 
 
Example use: <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> xml data available for xsl rendering: <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> <lumUserSessionId>8A488AF92CBBAF59012CBBD698420390</lumUserSessionId> <sii>8A488A1B2C6595B5012C6596FC8A01B6</sii> <folder>8A488AF92CBBAF59012CBBE219450556</folder> <allowedFileExtensions /> <fileDescription /> </def> </control>

Since:
6.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, 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, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
MultiFileUploadControl()
          Default constructor for MultiFileUploadControl.
 
Method Summary
 void buildSubControls()
           
 IResource getControlResource()
           
protected  String getFileDescription(String allowedFileExtensions)
          Returns the files description used on open file system window.
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, getUnboundedConverter, loadFromRequest, 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, setTrim, setValue, valueIsArray
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, 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, setValue
 
Methods inherited from interface lumis.doui.control.IControl
createContainer, disconnect, getChildControls, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes
 
Methods inherited from interface lumis.doui.render.IRenderer
getResources, getSourceContext
 

Constructor Detail

MultiFileUploadControl

public MultiFileUploadControl()
Default constructor for MultiFileUploadControl.

Since:
6.1.0
Method Detail

getControlResource

public IResource getControlResource()
                             throws PortalException
Specified by:
getControlResource in interface IControl
Overrides:
getControlResource in class Control
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

init

public void init(Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException
Specified by:
init in interface IControl
Overrides:
init in class DataBoundControl<TabularSource<ITabularSourceField>>
Throws:
PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException
Specified by:
buildSubControls in interface IControl
Overrides:
buildSubControls in class DataBoundControl<TabularSource<ITabularSourceField>>
Throws:
PortalException

setRenderData

public void setRenderData()
                   throws PortalException
Specified by:
setRenderData in interface IControl
Overrides:
setRenderData in class DataBoundControl<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 the PortalContext#getDataPath("upload").

Returns:
the folder where temporary uploads are done
Since:
6.1.0


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.