Module org.apache.wicket.extensions
Package 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, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, 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();
 
                <b>getApplicationSettings().setUploadProgressUpdatesEnabled(true);</b> // <--
        }
 }
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:

  • Field Details

  • Constructor Details

    • UploadProgressBar

      public UploadProgressBar(String id, FileUploadField uploadField)
      Constructor that will display the upload progress bar for every submit of the given form.
      Parameters:
      id - component id (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

    • 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 Details