public class ProgressBar
extends org.apache.wicket.markup.html.panel.Panel
The ProgressBar component displays a horizontal progress bar that is updatable via
AJAX and displays the progress of some task. The current progress is given with a
Progression value object.
This is a small example of a static ProgressBar without AJAX updates:
final ProgressBar bar;
add(bar = new ProgressBar("progress", new ProgressionModel() {
protected Progression getProgression() {
// progress is an int instance variable defined somewhere else
return new Progression(progress);
}
}));
If the model for getting the Progression is not known at the time of construction,
it could be injected later.
The progress bar can be used both actively or passively (e.g. to show progress in a wizard). The active progress bar must be started from within an ajax request (e.g. AjaxButton), as shown below:
form.add(new AjaxButton("button") {
protected void onSubmit(AjaxRequestTarget target, Form form) {
bar.start(target);
// start some task
}
}
The ProgressBar is automatically stopped (including AJAX updates) when the
isDone() method of the Progress object returns true. The bar can be
stopped anytime using the stop() method.
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 |
|---|
ProgressBar(String id,
ProgressionModel model) |
| Modifier and Type | Method and Description |
|---|---|
protected org.apache.wicket.model.AbstractReadOnlyModel<String> |
getLabelModel(ProgressionModel model)
Create the model for the label on the bar.
|
protected org.apache.wicket.model.IModel<String> |
getMessageModel(ProgressionModel model)
Create the model for the message label on the bar.
|
int |
getWidth() |
protected void |
onFinished(org.apache.wicket.ajax.AjaxRequestTarget target)
Override this method for custom action on finish of the task when progression.isDone()
This could be cleaning up or hiding the ProgressBar for example.
|
protected void |
onInitialize() |
void |
renderHead(org.apache.wicket.markup.head.IHeaderResponse response) |
void |
setWidth(int width)
Set the width of the progress bar.
|
void |
start(org.apache.wicket.ajax.AjaxRequestTarget target)
Start the progress bar.
|
getRegionMarkup, newMarkupSourcingStrategygetWebPage, getWebRequest, getWebResponse, getWebSessionadd, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, 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, visitChildrenadd, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, 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, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, 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, wrappublic ProgressBar(String id, ProgressionModel model)
public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
renderHead in interface org.apache.wicket.markup.html.IHeaderContributorrenderHead in class org.apache.wicket.Componentprotected void onInitialize()
onInitialize in class org.apache.wicket.MarkupContainerprotected org.apache.wicket.model.AbstractReadOnlyModel<String> getLabelModel(ProgressionModel model)
model - the ProgressionModelprotected org.apache.wicket.model.IModel<String> getMessageModel(ProgressionModel model)
model - the ProgressionModelpublic void start(org.apache.wicket.ajax.AjaxRequestTarget target)
target - protected void onFinished(org.apache.wicket.ajax.AjaxRequestTarget target)
target - public int getWidth()
public void setWidth(int width)
width - the width of the ProgressBar in pxCopyright © 2015. All rights reserved.