org.wicketstuff.progressbar.ProgressBar Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wicketstuff.progressbar;
import java.time.Duration;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.AjaxSelfUpdatingTimerBehavior;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.markup.head.CssHeaderItem;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.request.resource.PackageResourceReference;
import org.apache.wicket.request.resource.ResourceReference;
/**
*
* 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.
*
*
* @author Christopher Hlubek (hlubek)
*
*/
public class ProgressBar extends Panel
{
/**
*
*/
private static final long serialVersionUID = 1L;
private int width = 400;
private static final ResourceReference CSS = new PackageResourceReference(ProgressBar.class,
"ProgressBar.css");
@Override
public void renderHead(IHeaderResponse response)
{
super.renderHead(response);
response.render(CssHeaderItem.forReference(CSS));
}
@Override
protected void onInitialize()
{
super.onInitialize();
if (getParent() != null)
{
/*
* Add the css to our parent incase the bar is not initially visible.
*/
getParent().add(new Behavior()
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
public void renderHead(Component component, IHeaderResponse response)
{
super.renderHead(component, response);
response.render(CssHeaderItem.forReference(CSS));
}
});
}
}
public ProgressBar(String id, ProgressionModel model)
{
super(id, model);
// add CSS to parent to render the CSS even if the progress bar is initially
// invisible
add(new Label("label", getLabelModel(model)));
add(new Label("message", getMessageModel(model)));
add(new WebMarkupContainer("bar").add(new AttributeModifier("style",
new IModel()
{
private static final long serialVersionUID = 1L;
@Override
public String getObject()
{
ProgressionModel model = (ProgressionModel)getDefaultModel();
Progression progression = model.getProgression();
// set the width of the bar in % of the progress
// this is coupled with the specific CSS
return "width: " + progression.getProgress() + "%";
}
})));
setOutputMarkupId(true);
}
/**
* Create the model for the label on the bar.
*
* This could be overridden for a custom label
*
* @param model
* the ProgressionModel
*
* @return A model for the bar label
*/
protected IModel getLabelModel(final ProgressionModel model)
{
return new IModel()
{
private static final long serialVersionUID = 1L;
@Override
public String getObject()
{
Progression progression = model.getProgression();
return progression.getProgress() + "%";
}
};
}
/**
* Create the model for the message label on the bar.
*
* This could be overridden for a custom message label
*
* @param model
* the ProgressionModel
*
* @return A model for the bar message label
*/
protected IModel getMessageModel(final ProgressionModel model)
{
return new IModel()
{
private static final long serialVersionUID = 1L;
@Override
public String getObject()
{
return model.getProgression().getProgressMessage();
}
};
}
/**
* Start the progress bar.
*
* This must happen in an AJAX request.
*
* @param target
*/
public void start(AjaxRequestTarget target)
{
setVisible(true);
add(new AjaxSelfUpdatingTimerBehavior(Duration.ofSeconds(1))
{
/**
*
*/
private static final long serialVersionUID = 1L;
@Override
protected void onPostProcessTarget(AjaxRequestTarget target)
{
ProgressionModel model = (ProgressionModel)getDefaultModel();
Progression progression = model.getProgression();
if (progression.isDone())
{
// stop the self update
stop(target);
// do custom action
onFinished(target);
}
}
});
if (getParent() != null)
{
target.add(getParent());
}
else
{
target.add(this);
}
}
/**
* 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.
*
* @param target
*/
protected void onFinished(AjaxRequestTarget target)
{
}
/**
*
* @return the width of the ProgressBar
*/
public int getWidth()
{
return width;
}
/**
* Set the width of the progress bar.
*
* @param width
* the width of the ProgressBar in px
*/
public void setWidth(int width)
{
this.width = width;
}
}