Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.wicketstuff.async.components
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.apache.wicket.markup.html.panel.Panel
                  extended by org.wicketstuff.async.components.ProgressBar
All Implemented Interfaces:
Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable
public class ProgressBar
extends Panel

This component renders a progress bar to an existent task which is controlled by a progress button.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.wicket.markup.html.panel.Panel
PANEL
 
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, ProgressButton progressButton)
           
 
Method Summary
protected  double getDefaultWidth()
          Determines the default width of the progress bar when there is no information available.
protected  boolean isShowPercentage()
          Determines if the task progress in percentage is showed within the bar.
protected  WebMarkupContainer makeBar(String id)
           
protected  WebMarkupContainer makeWrapper(String id)
           
 void registerCssClassModel(IModel<String> textModel, InteractionState... interactionStates)
          Adds a model for a css class which will be appended if any of the interactionStates apply, disregarding any possible task state.
 void registerCssClassModel(IModel<String> textModel, TaskState... taskStates)
          Adds a model for a css class which will be appended if any of the taskStates apply, disregarding any possible interaction state.
 void registerCssClassModel(IModel<String> textModel, TaskState taskState, InteractionState interactionState)
          Adds a model for a css class which will be appended only if taskState and interactionState apply.
 
Methods inherited from class org.apache.wicket.markup.html.panel.Panel
newMarkupSourcingStrategy
 
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, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, 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(String id,
                   ProgressButton progressButton)
Method Detail

makeWrapper

protected WebMarkupContainer makeWrapper(String id)

makeBar

protected WebMarkupContainer makeBar(String id)

isShowPercentage

protected boolean isShowPercentage()
Determines if the task progress in percentage is showed within the bar.

Returns:
true if the number should be shown.

getDefaultWidth

protected double getDefaultWidth()
Determines the default width of the progress bar when there is no information available.

Returns:
The default width. Should be between 0 and 1. Values outside this interval will be trucated.

registerCssClassModel

public void registerCssClassModel(IModel<String> textModel,
                                  TaskState taskState,
                                  InteractionState interactionState)
Adds a model for a css class which will be appended only if taskState and interactionState apply.

Parameters:
textModel - The model to be appended.
taskState - The relevant task state.
interactionState - The relevant interaction state.

registerCssClassModel

public void registerCssClassModel(IModel<String> textModel,
                                  TaskState... taskStates)
Adds a model for a css class which will be appended if any of the taskStates apply, disregarding any possible interaction state.

Parameters:
textModel - The model to be appended.
taskStates - All relevant task states.

registerCssClassModel

public void registerCssClassModel(IModel<String> textModel,
                                  InteractionState... interactionStates)
Adds a model for a css class which will be appended if any of the interactionStates apply, disregarding any possible task state.

Parameters:
textModel - The model to be appended.
interactionStates - All relevant interaction states.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2013–2014 Kantega AS. All rights reserved.