org.odlabs.wiquery.ui.progressbar
Class ProgressBar

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.odlabs.wiquery.ui.progressbar.ProgressBar
All Implemented Interfaces:
Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IClusterable, 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>, IWiQueryPlugin

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

$Id$

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

Since:
1.0
Author:
Lionel Armanet
See Also:
Serialized Form

Field Summary
 
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
ProgressBar(String id)
          Builds a new progress bar.
 
Method Summary
 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()
           
 void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)
           
 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
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 org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, 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, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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, 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

renderHead

public void renderHead(org.apache.wicket.markup.html.IHeaderResponse response)
Specified by:
renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
Overrides:
renderHead in class org.apache.wicket.Component

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 -


Copyright © 2012. All Rights Reserved.