public class UploadProgressBar extends Panel
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.Modifier and Type | Class and Description |
---|---|
static class |
UploadProgressBar.ComponentInitializer
Initializer for this component; binds static resources.
|
Modifier and Type | Field and Description |
---|---|
static String |
RESOURCE_STARTING
Resource key used to retrieve starting message for.
|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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()
This method is meant to be used as an alternative to initialize components.
|
void |
renderHead(IHeaderResponse response)
Render to the web response whatever the component wants to contribute to the head section.
|
getRegionMarkup, newMarkupSourcingStrategy
getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession
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, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren
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, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
dequeue, newDequeueContext
public static final String RESOURCE_STARTING
public UploadProgressBar(String id, Form<?> form)
id
- component id (not null)form
- form that will be submitted (not null)public UploadProgressBar(String id, Form<?> form, FileUploadField uploadField)
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 formprotected void onInitialize()
Component
Page
thus providing the component with an atomic callback
when the component's environment is built out.
Overrides must call super#Component.onInitialize()
. Usually this should be the first thing an
override does, much like a constructor.
Parent containers are guaranteed to be initialized before their children
It is safe to use Component.getPage()
in this method
NOTE:The timing of this call is not precise, the contract is that it is called sometime
before Component.onBeforeRender()
.
onInitialize
in class MarkupContainer
protected MarkupContainer newStatusComponent(String id)
id
- The component idprotected MarkupContainer newBarComponent(String id)
id
- The component idprotected ResourceReference getCss()
public void renderHead(IHeaderResponse response)
renderHead
in interface IHeaderContributor
renderHead
in class Component
response
- Response objectCopyright © 2006–2021 Apache Software Foundation. All rights reserved.