org.wicketstuff.async.components

Class ProgressBar

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.wicketstuff.async.components.ProgressBar

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IQueueRegion, 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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor and Description
ProgressBar(String id, ProgressButton progressButton)

Method Summary

Modifier and Type	Method and Description
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

getRegionMarkup, newMarkupSourcingStrategy

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, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, 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, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, 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 class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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.