to.etc.domui.component.upload

Class FileUpload

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Div

to.etc.domui.component.upload.FileUpload

All Implemented Interfaces:

Iterable<NodeBase>, IUploadAcceptingComponent, INodeErrorDelegate, IActionControl, IControl<UploadItem>, IHasChangeListener, IDraggable, IDropBody, IDropTargetable

public class FileUpload
extends Div
implements IUploadAcceptingComponent, IControl<UploadItem>

Represents a file upload thingy which handles ajaxy uploads. The basic model is as follows:

• FileUpload components use a hidden iframe to handle the actual uploading in the background.
• The background upload gets started as soon as a selection is made.
• While the upload is running the user interface is blocking
• The uploaded file will be attached as a tempfile to the form's component. It will be deleted as soon as the context or the page is destroyed.
• No upload progress reporting is done.

Client side upload thingy

In the browser the primary upload thingy is an input type='file' component. This gets used to allow the user to add a file. As soon as a file is selected an onchange event will ensure the posting of the file to the server using an AJAX/IFrame upload. This upload will be received by the Upload part which will attach the file to the control doing the upload. When the upload is complete the input type="file" thing gets replaced by a "file reference" containing the input filename and a delete button. If the input thingy allows for multiple files to be uploaded another input type="file" gets added above that.

Important info regarding IE use of iframe: http://p2p.wrox.com/topic.asp?whichpage=1&TOPIC_ID=62981𥟺

Author:

Frits Jalvingh Created on Oct 13, 2008

Constructor Summary

Constructors

Constructor and Description
FileUpload()
FileUpload(int maxfiles, String allowedExt) Create an upload item that acceps a max #of files and a set of extensions.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	createContent()
String	getAllowedExtensions() Return the space separated list of allowed file extensions.
List<UploadItem>	getFiles() Return the current value: the list of files that have been uploaded and their related data.
int	getMaxFiles()
int	getMaxSize()
IValueChanged<?>	getOnValueChanged()
UploadItem	getValue() Returns the current value of this input component.
UploadItem	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	handleUploadRequest(RequestContextImpl param, ConversationContext conversation)
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isFull() Return T if the max.
boolean	isMandatory() T if at least 1 file needs to be uploaded.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
void	removeAllUploads()
void	removeUploadItem(UploadItem ufi) Removes specified upload item.
void	setAllowedExtensions(String allowedExtensions) Set the list of allowed file extensions.
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setMandatory(boolean required) Set to T if at least one file needs to have been uploaded.
void	setMaxFiles(int maxFiles)
void	setMaxSize(int maxSize)
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setReadOnly(boolean readOnly) Sets the input to readonly-mode.
void	setValue(UploadItem v) Set a new value into this control.

Methods inherited from class to.etc.domui.dom.html.Div

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface to.etc.domui.dom.html.IControl

getErrorLocation, hasError, setErrorLocation

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FileUpload

public FileUpload()

FileUpload

public FileUpload(int maxfiles,
                  String allowedExt)

Create an upload item that acceps a max #of files and a set of extensions.

Parameters:

maxfiles -

allowedExt -

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

getFiles

@Nonnull
public List<UploadItem> getFiles()

Return the current value: the list of files that have been uploaded and their related data. The UploadItem contains a reference to the actual file UploadItem.getFile(); this file remains present only while the page is still alive. If the page is destroyed all of it's uploaded files will be deleted. So if you need to retain the file somehow after upload it's contents needs to be copied to either another file that you control or to a BLOB in a database.

Returns:

getValue

@Nullable
public UploadItem getValue()

Description copied from interface: IControl

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call IControl.getValueSafe().

Specified by:

getValue in interface IControl<UploadItem>

Returns:

setValue

public void setValue(@Nullable
                     UploadItem v)

Description copied from interface: IControl

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Specified by:

setValue in interface IControl<UploadItem>

getValueSafe

@Nullable
public UploadItem getValueSafe()

Description copied from interface: IControl

Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<UploadItem>

Returns:

isFull

public boolean isFull()

Return T if the max. #of files has been reached.

Returns:

removeUploadItem

public void removeUploadItem(UploadItem ufi)

Removes specified upload item.

Parameters:

ufi -

removeAllUploads

public void removeAllUploads()

clear

public void clear()

getAllowedExtensions

public String getAllowedExtensions()

Return the space separated list of allowed file extensions.

Returns:

setAllowedExtensions

public void setAllowedExtensions(String allowedExtensions)

Set the list of allowed file extensions.

Parameters:

allowedExtensions -

isMandatory

public boolean isMandatory()

T if at least 1 file needs to be uploaded.

Specified by:

isMandatory in interface IControl<UploadItem>

Returns:

setMandatory

public void setMandatory(boolean required)

Set to T if at least one file needs to have been uploaded.

Specified by:

setMandatory in interface IControl<UploadItem>

Parameters:

required -

getMaxFiles

public int getMaxFiles()

setMaxFiles

public void setMaxFiles(int maxFiles)

getOnValueChanged

public IValueChanged<?> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

setOnValueChanged

public void setOnValueChanged(IValueChanged<?> onValueChanged)

Specified by:

setOnValueChanged in interface IHasChangeListener

isDisabled

public boolean isDisabled()

Description copied from interface: IControl

Returns T if the control is currently in disabled. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isDisabled in interface IControl<UploadItem>

Returns:

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

getMaxSize

public int getMaxSize()

setMaxSize

public void setMaxSize(int maxSize)

handleUploadRequest

public boolean handleUploadRequest(@Nonnull
                                   RequestContextImpl param,
                                   @Nonnull
                                   ConversationContext conversation)
                            throws Exception

Specified by:

handleUploadRequest in interface IUploadAcceptingComponent

Throws:

Exception

isReadOnly

public boolean isReadOnly()

Description copied from interface: IControl

Returns T if the control is currently in readonly mode. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isReadOnly in interface IControl<UploadItem>

Returns:

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: IControl

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Specified by:

setReadOnly in interface IControl<UploadItem>