Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.markup.html.bootstrap.components.progress

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.apache.wicket.markup.html.panel.GenericPanel<Integer>

de.agilecoders.wicket.core.markup.html.bootstrap.components.progress.ProgressBar

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<Integer,GenericPanel<Integer>>, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

UpdatableProgressBar

public class ProgressBar
extends GenericPanel<Integer>

A component for Progress bars

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX
static final int	MIN

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	Description
ProgressBar(String id)	Constructor.
ProgressBar(String id, IModel<Integer> model)	Constructor.
ProgressBar(String id, IModel<Integer> model, boolean labeled)	Constructor.
ProgressBar(String id, IModel<Integer> model, BackgroundColorBehavior.Color color)	Constructor.
ProgressBar(String id, IModel<Integer> model, BackgroundColorBehavior.Color color, boolean labeled)	Constructor.
ProgressBar(String id, IModel<Integer> model, BackgroundColorBehavior.Color color, boolean labeled, boolean animated, boolean striped)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	active()
ProgressBar	active(boolean value)
ProgressBar	addStacks(Stack... _stacks)	Adds stacks to this progress bar.
final boolean	complete()	Returns whether the progress bar is complete or not.
String	getStackId()	Generates a safe component id for a stack in this progress bar
protected void	onComponentTag(ComponentTag tag)
void	renderHead(IHeaderResponse response)
boolean	striped()
ProgressBar	striped(boolean value)
Integer	value()	Returns the current value of the progress.
ProgressBar	value(Integer value)	Sets a new value for the progress.
ProgressBar	value(IModel<Integer> value)	Sets a new value for the progress.

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, getMarkupTag, 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, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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.IGenericComponent

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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

MIN

public static final int MIN

See Also:

• Constant Field Values

MAX

public static final int MAX

See Also:

• Constant Field Values

Constructor Details

ProgressBar

public ProgressBar(String id)

Constructor. Creates an empty progress bar. Use addStacks(Stack...) to add stacks to it

Parameters:

id - The component id

See Also:

• ProgressBar(String, org.apache.wicket.model.IModel, de.agilecoders.wicket.core.markup.html.bootstrap.utilities.BackgroundColorBehavior.Color, boolean, boolean, boolean)
• addStacks(Stack...)

ProgressBar

public ProgressBar(String id,
 IModel<Integer> model)

Constructor. Creates a progress bar with a stack that uses the given model, default type and is not labeled.

Parameters:

id - The component id

model - The model that will be used for the default stack.

See Also:

• ProgressBar(String)

ProgressBar

public ProgressBar(String id,
 IModel<Integer> model,
 BackgroundColorBehavior.Color color)

Constructor. Creates a progress bar with a stack that uses the given model, type and is not labeled.

Parameters:

id - The component id

model - The model that will be used for the default stack.

color - The color of the stack

See Also:

• ProgressBar(String)

ProgressBar

public ProgressBar(String id,
 IModel<Integer> model,
 boolean labeled)

Constructor. Creates a progress bar with a stack that uses the given model, default type and it is labeled or not.

Parameters:

id - The component id

model - The model that will be used for the default stack.

labeled - A flag whether the stack should be labeled or not

See Also:

• ProgressBar(String)

ProgressBar

public ProgressBar(String id,
 IModel<Integer> model,
 BackgroundColorBehavior.Color color,
 boolean labeled)

Constructor. Creates a progress bar with a stack that uses the given model, type and is labeled or not.

Parameters:

id - The component id

model - The model that will be used for the default stack.

color - The color of the stack

labeled - A flag whether the stack should be labeled or not

See Also:

• ProgressBar(String)

ProgressBar

public ProgressBar(String id,
 IModel<Integer> model,
 BackgroundColorBehavior.Color color,
 boolean labeled,
 boolean animated,
 boolean striped)

Constructor. Creates a progress bar with a stack that uses the given model, type, is labeled or not, is animated or not, is striped or not.

Parameters:

id - The component id

model - The model that will be used for the default stack.

color - The color of the stack

labeled - A flag whether the stack should be labeled or not

animated - A flag indicating whether the stack is active/active.

striped - A flag indicating whether the stack is striped.

See Also:

• ProgressBar(String)

Method Details

getStackId

public String getStackId()

Generates a safe component id for a stack in this progress bar

Returns:

a component id for a stack

addStacks

public ProgressBar addStacks(Stack... _stacks)

Adds stacks to this progress bar.

Parameters:

_stacks - The stacks to add

Returns:

this instance, for method chaining

striped

public boolean striped()

striped

public ProgressBar striped(boolean value)

active

public boolean active()

active

public ProgressBar active(boolean value)

complete

public final boolean complete()

Returns whether the progress bar is complete or not. Useful only when used with the default stack, i.e. only when a constructor different than ProgressBar(String) is used!

Returns:

true if the progress bar is complete.

value

public ProgressBar value(IModel<Integer> value)

Sets a new value for the progress. Useful only when used with the default stack, i.e. only when a constructor different than ProgressBar(String) is used!

Returns:

this instance, for method chaining.

value

public ProgressBar value(Integer value)

Sets a new value for the progress. Useful only when used with the default stack, i.e. only when a constructor different than ProgressBar(String) is used!

Returns:

this instance, for method chaining.

value

public Integer value()

Returns the current value of the progress. Useful only when used with the default stack, i.e. only when a constructor different than ProgressBar(String) is used!

Returns:

the current value of the progress.

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Component

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component