lumis.doui.control.fileupload
Class FileUploadControl

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.DataControl
          lumis.doui.control.DataBoundControl
              lumis.doui.control.fileupload.FileUploadControl

All Implemented Interfaces:

Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

public class FileUploadControl
extends DataBoundControl
implements IClientSideReadableControl

Doui control that allows the upload of files to the portal.

Behavior, according to the request parameters:

• Parameter <control id>_prevFileId must be contain the original fileId if the field currently has a file data in it.
• If the parameter <control id>_clearFile has value equals to true, then this control's data fullPath is set to null, to indicate that the file should be removed, and the upload is ignored.
• Else if the parameter, whose name is specified in the xml filenameField tag, is present, the current file (if present) is renamed to the parameter's value.
• Else if a file is uploaded with the parameter name equals to this control's id, and there is no previous file or the parameter <control id>_replaceFile has value equals to true, then the field's value will be changed to the uploaded file.


Example use: <control:lum_fileUpload id="imageFile" /> xml data available for xsl rendering: <control id="imageFile" type="lum_fileUpload"> <strings> <string id="STR_REMOVE">Remove</string> <string id="STR_FILE_NOT_FOUND">File not found</string> <string id="STR_FILE_REMOVED">File Removed</string> <string id="STR_CANCEL_UPLOAD">Cancel Upload</string> <string id="STR_DOWNLOAD">Download</string> <string id="STR_UPLOAD">Upload</string> </strings> <data> <suffixId>imageFile</suffixId> </data> </control>

Since:

4.0.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_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

FileUploadControl()


Method Summary

void	buildSubControls()
protected String	getFilenameParameterName(String fieldId)
protected String	getScriptGetValuesFunctionImplementation()
protected Map<String,String>	getStringsToLocalize()
protected Class	getValueClass() Returns the class the possible values of this control are assignable to.
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
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, 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, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, 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, 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

FileUploadControl

public FileUploadControl()

Method Detail

getFilenameParameterName

protected String getFilenameParameterName(String fieldId)

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

getValueClass

protected 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

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getStringsToLocalize

protected Map<String,String> getStringsToLocalize()

Overrides:

getStringsToLocalize in class Control

getScriptGetValuesFunctionImplementation

protected String getScriptGetValuesFunctionImplementation()
                                                   throws ControlException,
                                                          PortalException

Overrides:

getScriptGetValuesFunctionImplementation in class Control

Throws:

ControlException

PortalException