org.hippoecm.frontend.plugins.yui.upload

Class FileUploadWidget

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

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

org.hippoecm.frontend.plugins.yui.upload.FileUploadWidget

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderPartContainerProvider

public class FileUploadWidget
extends org.apache.wicket.markup.html.panel.Panel

Widget for uploading files. This widget allows both flash and non-flash uploads based on the configuration. By default the flash upload is used. For more configuration options please take a look at FileUploadWidgetSettings.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
FileUploadWidget(String id, FileUploadWidgetSettings settings)
FileUploadWidget(String id, FileUploadWidgetSettings settings, FileUploadValidationService validator)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getAjaxIndicatorId() Traverse up the component tree in search for an IAjaxIndicatorAware component is used to indicate a busy state while uploading.
String	getAjaxIndicatorStopScript()
String	getStartAjaxUploadScript() Components that embed a FileUploadWidget might have their own actions for triggering the upload, this method returns the javascript call to initiate it.
String	hasFileSelectedScript()
boolean	isFlashUpload() Detect if flash is installed and if the correct version of the flash plugin is found.
protected void	onBeforeRender() Check if the client supports flash by looking up the WebAppBehavior in the page which test the client for flash on the first load and saves the version.
protected void	onFileUpload(org.apache.wicket.markup.html.form.upload.FileUpload fileUpload) Hook method for subclasses to handle an upload once it has passed validation.
protected void	onFinishAjaxUpload(org.apache.wicket.ajax.AjaxRequestTarget target)
void	onFinishHtmlUpload() The HTML4 upload will collect the new files in the MultiFileUploadComponent, after the form has been completly submitted, onFinishHtmlUpload is called which will process
protected void	onFinishUpload()
protected void	renderFlashUpload()
protected void	renderJavascriptUpload()

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

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUploadWidget

public FileUploadWidget(String id,
                FileUploadWidgetSettings settings)

FileUploadWidget

public FileUploadWidget(String id,
                FileUploadWidgetSettings settings,
                FileUploadValidationService validator)

Method Detail

onBeforeRender

protected void onBeforeRender()

Check if the client supports flash by looking up the WebAppBehavior in the page which test the client for flash on the first load and saves the version.

Overrides:

onBeforeRender in class org.apache.wicket.Component

getAjaxIndicatorId

protected String getAjaxIndicatorId()

Traverse up the component tree in search for an IAjaxIndicatorAware component is used to indicate a busy state while uploading.

Returns:

IAjaxIndicatorAware component or null of not found

renderFlashUpload

protected void renderFlashUpload()

isFlashUpload

public boolean isFlashUpload()

Detect if flash is installed and if the correct version of the flash plugin is found.

Returns:

true if flash and the correct version is detected, false otherwise

getStartAjaxUploadScript

public String getStartAjaxUploadScript()

Components that embed a FileUploadWidget might have their own actions for triggering the upload, this method returns the javascript call to initiate it.

Returns:

Javascript call that start the ajax upload

renderJavascriptUpload

protected void renderJavascriptUpload()

onFinishAjaxUpload

protected void onFinishAjaxUpload(org.apache.wicket.ajax.AjaxRequestTarget target)

onFinishHtmlUpload

public void onFinishHtmlUpload()

The HTML4 upload will collect the new files in the MultiFileUploadComponent, after the form has been completly submitted, onFinishHtmlUpload is called which will process

onFinishUpload

protected final void onFinishUpload()

onFileUpload

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

Hook method for subclasses to handle an upload once it has passed validation.

Parameters:

fileUpload - The uploaded file

getAjaxIndicatorStopScript

public String getAjaxIndicatorStopScript()

hasFileSelectedScript

public String hasFileSelectedScript()