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

Class ProgressBar

  • All Implemented Interfaces:
    com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, com.googlecode.wicket.jquery.core.event.IValueChangedListener, com.googlecode.wicket.jquery.core.IJQueryWidget, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<Integer,​com.googlecode.wicket.jquery.core.JQueryGenericContainer<Integer>>, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, 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 com.googlecode.wicket.jquery.core.JQueryGenericContainer<Integer>
implements com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware, com.googlecode.wicket.jquery.core.event.IValueChangedListener
    Provides a jQuery progress-bar based on a JQueryGenericContainer
    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

        com.googlecode.wicket.jquery.core.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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void backward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
      Decrements the progress-bar value by 1
      void backward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, int step)
      Decrements the progress-bar value by the specified step value
      void forward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
      Increments the progress-bar value by 1
      void forward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, int step)
      Increments the progress-bar value by the specified step value
      com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior​(String selector)  
      void onAjax​(org.apache.wicket.ajax.AjaxRequestTarget target, com.googlecode.wicket.jquery.core.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.core.request.handler.IPartialPageRequestHandler handler)  
      void refresh​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
      Refreshes 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.
      com.googlecode.wicket.jquery.core.JQueryGenericContainer<Integer> setModelObject​(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

        getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

      • Methods inherited from interface org.apache.wicket.IGenericComponent

        getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel

    • Constructor Detail

      • ProgressBar

        public ProgressBar​(String id)
        Constructor
        Parameters:
        id - the markup id

      • ProgressBar

        public ProgressBar​(String id,
                   org.apache.wicket.model.IModel<Integer> model)
        Constructor
        Parameters:
        id - the markup id
        model - the IModel

    • Method Detail

      • setModelObject

        public com.googlecode.wicket.jquery.core.JQueryGenericContainer<Integer> setModelObject​(Integer value)
        Sets the progress-bar value
        Specified by:
        setModelObject in interface org.apache.wicket.IGenericComponent<Integer,​com.googlecode.wicket.jquery.core.JQueryGenericContainer<Integer>>
        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.core.request.handler.IPartialPageRequestHandler handler)
        Increments the progress-bar value by 1
        Parameters:
        handler - the IPartialPageRequestHandler

      • forward

        public final void forward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                          int step)
        Increments the progress-bar value by the specified step value
        Parameters:
        handler - the IPartialPageRequestHandler
        step - the value

      • backward

        public final void backward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
        Decrements the progress-bar value by 1
        Parameters:
        handler - the IPartialPageRequestHandler

      • backward

        public final void backward​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                           int step)
        Decrements the progress-bar value by the specified step value
        Parameters:
        handler - the IPartialPageRequestHandler
        step - the value

      • refresh

        public final void refresh​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
        Refreshes 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:
        handler - the IPartialPageRequestHandler

      • onAjax

        public void onAjax​(org.apache.wicket.ajax.AjaxRequestTarget target,
                   com.googlecode.wicket.jquery.core.JQueryEvent event)
        Specified by:
        onAjax in interface com.googlecode.wicket.jquery.core.ajax.IJQueryAjaxAware

      • onValueChanged

        public void onValueChanged​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler)
        Specified by:
        onValueChanged in interface com.googlecode.wicket.jquery.core.event.IValueChangedListener

      • 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 com.googlecode.wicket.jquery.core.JQueryBehavior newWidgetBehavior​(String selector)
        Specified by:
        newWidgetBehavior in interface com.googlecode.wicket.jquery.core.IJQueryWidget