|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class UploadProgressBar
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.
Nested Class Summary | |
---|---|
static class |
UploadProgressBar.ComponentInitializer
Initializer for this component; binds static resources. |
Field Summary | |
---|---|
static java.lang.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(java.lang.String id,
Form<?> form)
Constructor that will display the upload progress bar for every submit of the given form. |
|
UploadProgressBar(java.lang.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 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. |
Methods inherited from class org.apache.wicket.markup.html.panel.Panel |
---|
newMarkupSourcingStrategy |
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer |
---|
getWebPage, getWebRequest |
Methods inherited from class org.apache.wicket.MarkupContainer |
---|
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RESOURCE_STARTING
Constructor Detail |
---|
public UploadProgressBar(java.lang.String id, Form<?> form)
id
- component id (not null)form
- form that will be submitted (not null)public UploadProgressBar(java.lang.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 formMethod Detail |
---|
protected void onInitialize()
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 Component
protected ResourceReference getCss()
public void renderHead(IHeaderResponse response)
renderHead
in interface IHeaderContributor
renderHead
in class Component
response
- Response object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |