org.hippoecm.frontend.plugins.jquery.upload

Class AbstractFileUploadWidget

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.hippoecm.frontend.plugins.jquery.upload.AbstractFileUploadWidget

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

FileUploadWidget, SingleFileUploadWidget

public abstract class AbstractFileUploadWidget
extends org.apache.wicket.markup.html.panel.Panel

The abstract file upload widget. When uploading a file, the widget should provide the following events in sequence:

• onBeforeUpload(FileUploadInfo)
• onFileUpload(FileUpload fileUpload)
• onUploadError(FileUploadInfo)
• onAfterUpload(FileItem, FileUploadInfo)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FileUploadWidgetSettings	settings

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
AbstractFileUploadWidget(String id, IPluginConfig pluginConfig, FileUploadValidationService validator) Deprecated.
AbstractFileUploadWidget(String id, IPluginConfig pluginConfig, FileUploadValidationService validator, FileUploadPreProcessorService preProcessorService)

Method Summary

Modifier and Type	Method and Description
FileUploadWidgetSettings	getSettings()
String	getUploadScript()
protected void	onAfterUpload(org.apache.commons.fileupload.FileItem file, FileUploadInfo fileUploadInfo) The event is fired after the selecting files has been processed and uploaded.
protected void	onBeforeUpload(FileUploadInfo fileUploadInfo) The event is fired before processing the uploaded file.
protected abstract void	onFileUpload(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload) Override this method to handle uploading files
protected void	onFinished(org.apache.wicket.ajax.AjaxRequestTarget target, int numberOfFiles, boolean error) The event is fired after all files has been uploaded.
protected void	onUploadError(FileUploadInfo fileUploadInfo) The event is fired when there is an error during processing uploaded file.
protected org.apache.wicket.markup.html.form.upload.FileUpload	preProcess(org.apache.commons.fileupload.FileItem fileItem, org.apache.wicket.markup.html.form.upload.FileUpload originalFileUpload) Executes custom preProcessors, a new FileUpload object will be returned
protected void	process(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload) It calls onFileUpload(FileUpload)
protected void	validate(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload) Validate file upload item against the file upload validation service defined in AbstractFileUploadWidget(String, IPluginConfig, FileUploadValidationService)

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

settings

protected final FileUploadWidgetSettings settings

Constructor Detail

AbstractFileUploadWidget

@Deprecated
public AbstractFileUploadWidget(String id,
                                            IPluginConfig pluginConfig,
                                            FileUploadValidationService validator)

Deprecated.

AbstractFileUploadWidget

public AbstractFileUploadWidget(String id,
                                IPluginConfig pluginConfig,
                                FileUploadValidationService validator,
                                FileUploadPreProcessorService preProcessorService)

Method Detail

getUploadScript

public String getUploadScript()

validate

protected void validate(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload)
                 throws FileUploadViolationException

Validate file upload item against the file upload validation service defined in AbstractFileUploadWidget(String, IPluginConfig, FileUploadValidationService)

Parameters:

fileUpload -

Throws:

FileUploadViolationException

preProcess

protected org.apache.wicket.markup.html.form.upload.FileUpload preProcess(org.apache.commons.fileupload.FileItem fileItem,
                                                                          org.apache.wicket.markup.html.form.upload.FileUpload originalFileUpload)
                                                                   throws Exception

Executes custom preProcessors, a new FileUpload object will be returned

Parameters:

fileItem -

originalFileUpload -

Throws:

Exception

process

protected void process(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload)
                throws FileUploadViolationException

It calls onFileUpload(FileUpload)

Parameters:

fileUpload -

Throws:

FileUploadViolationException

getSettings

public FileUploadWidgetSettings getSettings()

onBeforeUpload

protected void onBeforeUpload(FileUploadInfo fileUploadInfo)

The event is fired before processing the uploaded file.

onFileUpload

protected abstract void onFileUpload(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload)
                              throws FileUploadViolationException

Override this method to handle uploading files

Parameters:

fileUpload -

Throws:

FileUploadViolationException

onUploadError

protected void onUploadError(FileUploadInfo fileUploadInfo)

The event is fired when there is an error during processing uploaded file.

Parameters:

fileUploadInfo -

onAfterUpload

protected void onAfterUpload(org.apache.commons.fileupload.FileItem file,
                             FileUploadInfo fileUploadInfo)

The event is fired after the selecting files has been processed and uploaded.

onFinished

protected void onFinished(org.apache.wicket.ajax.AjaxRequestTarget target,
                          int numberOfFiles,
                          boolean error)

The event is fired after all files has been uploaded.

Parameters:

target -

numberOfFiles - number of uploaded files

error - true if there is any error in uploading files