com.googlecode.wicket.jquery.ui.widget.progressbar

Class ProgressBar

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.googlecode.wicket.jquery.core.JQueryContainer

com.googlecode.wicket.jquery.ui.widget.progressbar.ProgressBar

All Implemented Interfaces:

IJQueryAjaxAware, IValueChangedListener, IJQueryWidget, java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class ProgressBar
extends JQueryContainer
implements IJQueryAjaxAware, IValueChangedListener

Provides a jQuery progress-bar based on a JQueryContainer

Since:

1.0

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryContainer

widgetBehavior

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

Constructors

Constructor and Description
ProgressBar(java.lang.String id) Constructor
ProgressBar(java.lang.String id, org.apache.wicket.model.IModel<java.lang.Integer> model) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	backward(org.apache.wicket.ajax.AjaxRequestTarget target) Decrements the progress-bar value by 1
void	backward(org.apache.wicket.ajax.AjaxRequestTarget target, int step) Decrements the progress-bar value by the specified step value
void	forward(org.apache.wicket.ajax.AjaxRequestTarget target) Increments the progress-bar value by 1
void	forward(org.apache.wicket.ajax.AjaxRequestTarget target, int step) Increments the progress-bar value by the specified step value
org.apache.wicket.model.IModel<java.lang.Integer>	getModel() Gets the model (wrapping the value)
java.lang.Integer	getModelObject() Gets the model object
JQueryBehavior	newWidgetBehavior(java.lang.String selector)
void	onAjax(org.apache.wicket.ajax.AjaxRequestTarget target, JQueryEvent event)
protected void	onComplete(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when the value reach MAX
protected void	onModelChanged()
void	onValueChanged(org.apache.wicket.ajax.AjaxRequestTarget target) Triggered when the value changed
void	refresh(org.apache.wicket.ajax.AjaxRequestTarget target) refresh the ProgressBar. This method needs to be called after the model object changes. But It is not required to be called when calling forward or backward methods.
void	setModelObject(java.lang.Integer value) Sets the progress-bar value

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryContainer

onBeforeRender, onConfigure, onInitialize

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgressBar

public ProgressBar(java.lang.String id)

Constructor

Parameters:

id - the markup id

ProgressBar

public ProgressBar(java.lang.String id,
           org.apache.wicket.model.IModel<java.lang.Integer> model)

Constructor

Parameters:

id - the markup id

model - the IModel

Method Detail

getModel

public org.apache.wicket.model.IModel<java.lang.Integer> getModel()

Gets the model (wrapping the value)

Returns:

IModel

getModelObject

public java.lang.Integer getModelObject()

Gets the model object

Returns:

the progress-bar value

setModelObject

public void setModelObject(java.lang.Integer value)

Sets the progress-bar value

Parameters:

value - value which should be greater than or equals to MIN and less than or equals to MAX

forward

public void forward(org.apache.wicket.ajax.AjaxRequestTarget target)

Increments the progress-bar value by 1

Parameters:

target - the AjaxRequestTarget

forward

public final void forward(org.apache.wicket.ajax.AjaxRequestTarget target,
           int step)

Increments the progress-bar value by the specified step value

Parameters:

target - the AjaxRequestTarget

step - the value

backward

public final void backward(org.apache.wicket.ajax.AjaxRequestTarget target)

Decrements the progress-bar value by 1

Parameters:

target - the AjaxRequestTarget

backward

public final void backward(org.apache.wicket.ajax.AjaxRequestTarget target,
            int step)

Decrements the progress-bar value by the specified step value

Parameters:

target - the AjaxRequestTarget

step - the value

refresh

public final void refresh(org.apache.wicket.ajax.AjaxRequestTarget target)

refresh the ProgressBar.
This method needs to be called after the model object changes.
But It is not required to be called when calling forward or backward methods.

Parameters:

target - the AjaxRequestTarget

onAjax

public void onAjax(org.apache.wicket.ajax.AjaxRequestTarget target,
          JQueryEvent event)

Specified by:

onAjax in interface IJQueryAjaxAware

onValueChanged

public void onValueChanged(org.apache.wicket.ajax.AjaxRequestTarget target)

Triggered when the value changed

Specified by:

onValueChanged in interface IValueChangedListener

Parameters:

target - the AjaxRequestTarget

onComplete

protected void onComplete(org.apache.wicket.ajax.AjaxRequestTarget target)

Triggered when the value reach MAX

Parameters:

target - the AjaxRequestTarget

onModelChanged

protected void onModelChanged()

Overrides:

onModelChanged in class org.apache.wicket.Component

newWidgetBehavior

public JQueryBehavior newWidgetBehavior(java.lang.String selector)

Specified by:

newWidgetBehavior in interface IJQueryWidget