org.odlabs.wiquery.ui.progressbar

Class ProgressBar

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.odlabs.wiquery.ui.progressbar.ProgressBar

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, IWiQueryPlugin

public class ProgressBar
extends org.apache.wicket.markup.html.WebMarkupContainer
implements IWiQueryPlugin

$Id: ProgressBar.java 553 2010-11-15 08:30:58Z hielke.hoeve@gmail.com $

Creates a progressBar UI component from this WebMarkupContainer's HTML markup.

Since:

1.0

Author:

Lionel Armanet

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
ProgressBar(String id) Builds a new progress bar.

Method Summary

Methods

Modifier and Type	Method and Description
void	contribute(WiQueryResourceManager wiQueryResourceManager) Declares resources (JavaScript and CSS files) to import.
JsStatement	decrement() Method to decrement the value of the progressBar
void	decrement(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to decrement the value of the progressBar within the ajax request
void	decrement(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget, int decrement) Method to decrement the value of the progressBar within the ajax request
JsStatement	decrement(int decrement) Method to decrement the value of the progressBar
JsStatement	destroy() Method to destroy the progressBar This will return the element back to its pre-init state.
void	destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to destroy the progressBar within the ajax request
protected void	detachModel()
JsStatement	disable() Method to disable the progressBar
void	disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to disable the progressBar within the ajax request
JsStatement	enable() Method to enable the progressBar
void	enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to enable the progressBar within the ajax request
protected Options	getOptions() Method retrieving the options of the component
int	getValue()
JsStatement	increment() Method to increment the value of the progressBar
void	increment(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to increment the value of the progressBar within the ajax request
void	increment(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget, int increment) Method to increment the value of the progressBar within the ajax request
JsStatement	increment(int increment) Method to increment the value of the progressBar
boolean	isDisabled()
ProgressBar	setChangeEvent(JsScopeUiEvent change) Set's the callback when the value of the progressBar changes.
ProgressBar	setDisabled(boolean disabled) Disables (true) or enables (false) the progressBar.
ProgressBar	setValue(int value) Sets the current value of the progressBar
JsStatement	statement() Returns the main JsStatement used to create the plugin.
JsStatement	update()
JsStatement	value() Method to get the current value of the progressBar
void	value(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget, int value) Method to set the current value of the progressBar within the ajax request
JsStatement	value(int value) Method to set the current value of the progressBar
JsStatement	widget() Method to returns the .ui-progressbar element
void	widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget) Method to returns the .ui-progressbar element within the ajax request

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, 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(String id)

Builds a new progress bar.

Method Detail

detachModel

protected void detachModel()

Overrides:

detachModel in class org.apache.wicket.Component

contribute

public void contribute(WiQueryResourceManager wiQueryResourceManager)

Description copied from interface: IWiQueryPlugin

Declares resources (JavaScript and CSS files) to import.

Specified by:

contribute in interface IWiQueryPlugin

Parameters:

wiQueryResourceManager - The WiQueryResourceManager instance managing this component resources.

statement

public JsStatement statement()

Description copied from interface: IWiQueryPlugin

Returns the main JsStatement used to create the plugin.

Specified by:

statement in interface IWiQueryPlugin

Returns:

The JsStatement corresponding to this component.

getOptions

protected Options getOptions()

Method retrieving the options of the component

Returns:

the options

update

public JsStatement update()

setDisabled

public ProgressBar setDisabled(boolean disabled)

Disables (true) or enables (false) the progressBar. Can be set when initialising (first creating) the progressBar.

Parameters:

disabled -

Returns:

instance of the current behavior

isDisabled

public boolean isDisabled()

Returns:

the disabled option

setValue

public ProgressBar setValue(int value)

Sets the current value of the progressBar

Parameters:

value -

Returns:

instance of the current component

getValue

public int getValue()

Returns:

the current value of the progressBar

setChangeEvent

public ProgressBar setChangeEvent(JsScopeUiEvent change)

Set's the callback when the value of the progressBar changes.

Parameters:

change -

Returns:

instance of the current component

destroy

public JsStatement destroy()

Method to destroy the progressBar This will return the element back to its pre-init state.

Returns:

the associated JsStatement

destroy

public void destroy(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to destroy the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

disable

public JsStatement disable()

Method to disable the progressBar

Returns:

the associated JsStatement

disable

public void disable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to disable the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

enable

public JsStatement enable()

Method to enable the progressBar

Returns:

the associated JsStatement

enable

public void enable(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to enable the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

value

public JsStatement value()

Method to get the current value of the progressBar

Returns:

the associated JsStatement

value

public JsStatement value(int value)

Method to set the current value of the progressBar

Parameters:

value -

Returns:

the associated JsStatement

value

public void value(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
         int value)

Method to set the current value of the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

value -

increment

public JsStatement increment()

Method to increment the value of the progressBar

Returns:

the associated JsStatement

increment

public JsStatement increment(int increment)

Method to increment the value of the progressBar

Parameters:

increment - The increment to add to the current value

Returns:

the associated JsStatement

increment

public void increment(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to increment the value of the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

increment

public void increment(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
             int increment)

Method to increment the value of the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

increment - The increment to add to the current value

decrement

public JsStatement decrement()

Method to decrement the value of the progressBar

Returns:

the associated JsStatement

decrement

public JsStatement decrement(int decrement)

Method to decrement the value of the progressBar

Parameters:

decrement - The decrement to add to the current value

Returns:

the associated JsStatement

decrement

public void decrement(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to decrement the value of the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

decrement

public void decrement(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget,
             int decrement)

Method to decrement the value of the progressBar within the ajax request

Parameters:

ajaxRequestTarget -

decrement - The decrement to add to the current value

widget

public JsStatement widget()

Method to returns the .ui-progressbar element

Returns:

the associated JsStatement

widget

public void widget(org.apache.wicket.ajax.AjaxRequestTarget ajaxRequestTarget)

Method to returns the .ui-progressbar element within the ajax request

Parameters:

ajaxRequestTarget -