org.apache.wicket.extensions.ajax.markup.html.form.upload
Class UploadProgressBar

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.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class UploadProgressBar
extends Panel

A panel to show the progress of an HTTP upload.

Note: For this to work upload progress monitoring must be enabled in the wicket application. Example:

 
  public class App extends WebApplication {
 
        @Override
        protected void init() {
                super.init();
 
                getApplicationSettings().setUploadProgressUpdatesEnabled(true); // <--
        }
 }
 
 

For customizing starting text see RESOURCE_STARTING. Implementation detail: Despite being located in an Ajax package, the progress communication is not done via Ajax but with an IFrame instead due to a bug in Webkit based browsers, see WICKET-3202.

Author:

Andrew Lombardi

See Also:

Serialized Form

Nested Class Summary

static class

UploadProgressBar.ComponentInitializer Initializer for this component; binds static resources.

Field Summary

static String

RESOURCE_STARTING Resource key used to retrieve starting message for.

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

PANEL

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

UploadProgressBar(String id, Form<?> form)
Constructor that will display the upload progress bar for every submit of the given form.

UploadProgressBar(String id, Form<?> form, FileUploadField uploadField)
Constructor that will display the upload progress bar for submissions of the given form, that include a file upload in the given file upload field; i.e.

Method Summary

protected ResourceReference	getCss() Override this to provide your own CSS, or return null to avoid including the default.
protected MarkupContainer	newBarComponent(String id) Creates a component for the bar
protected MarkupContainer	newStatusComponent(String id) Creates a component for the status text
protected void	onInitialize()
void	renderHead(IHeaderResponse response)

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

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, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, 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

Field Detail

RESOURCE_STARTING

public static final String RESOURCE_STARTING

Resource key used to retrieve starting message for. Example: UploadProgressBar.starting=Upload starting...

See Also:

Constant Field Values

Constructor Detail

UploadProgressBar

public UploadProgressBar(String id,
                         Form<?> form)

Constructor that will display the upload progress bar for every submit of the given form.

Parameters:

id - component id (not null)

form - form that will be submitted (not null)

UploadProgressBar

public UploadProgressBar(String id,
                         Form<?> form,
                         FileUploadField uploadField)

Constructor that will display the upload progress bar for submissions of the given form, that include a file upload in the given file upload field; i.e. if the user did not select a file in the given file upload field, the progess bar is not displayed.

Parameters:

id - component id (not null)

form - form that is submitted (not null)

uploadField - the file upload field to check for a file upload, or null to display the upload field for every submit of the given form

Method Detail

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class Component

newStatusComponent

protected MarkupContainer newStatusComponent(String id)

Creates a component for the status text

Parameters:

id - The component id

Returns:

the status component

newBarComponent

protected MarkupContainer newBarComponent(String id)

Creates a component for the bar

Parameters:

id - The component id

Returns:

the bar component

getCss

protected ResourceReference getCss()

Override this to provide your own CSS, or return null to avoid including the default.

Returns:

ResourceReference for your CSS.

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component