Module wicket.bootstrap.core

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

Class UploadProgressBar

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.extensions.ajax.markup.html.form.upload.UploadProgressBar

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

All Implemented Interfaces:

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

public class UploadProgressBar
extends UploadProgressBar

A specialization of wicket-extensions' UploadProgressBar that uses Bootstrap markup and styles.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar

UploadProgressBar.ComponentInitializer

Field Summary

Fields inherited from class org.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar

RESOURCE_STARTING

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
UploadProgressBar(String id, Form<?> form)	Constructor that will display the upload progress bar for every submit of the given form.
UploadProgressBar(String id, Form<?> form, FileUploadField fileUploadField, IModel<Integer> model)	Constructor that will display the upload progress bar for the given file upload field.
UploadProgressBar(String id, Form<?> form, IModel<Integer> model)	Constructor that will display the upload progress bar for every submit of the given form.

Method Summary

Modifier and Type	Method	Description
boolean	active()
UploadProgressBar	active(boolean value)
BackgroundColorBehavior.Color	color()
UploadProgressBar	color(BackgroundColorBehavior.Color color)
final boolean	complete()	Returns whether the progress bar is complete or not.
protected ResourceReference	getCss()
protected MarkupContainer	newBarComponent(String id)
protected MarkupContainer	newStatusComponent(String id)
protected void	onComponentTag(ComponentTag tag)
void	renderHead(IHeaderResponse response)
boolean	striped()
UploadProgressBar	striped(boolean value)
Integer	value()	Returns the current value of the progress.
UploadProgressBar	value(Integer value)	Sets a new value for the progress.
UploadProgressBar	value(IModel<Integer> value)	Sets a new value for the progress.

Methods inherited from class org.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar

getOnProgressUpdatedCallBack, onInitialize, start

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, 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.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

UploadProgressBar

public UploadProgressBar(String id,
 Form<?> form)

Constructor that will display the upload progress bar for every submit of the given form. Starts with initial progress value of 0

Parameters:

id - The component id

form - The form with the file upload fields

UploadProgressBar

public UploadProgressBar(String id,
 Form<?> form,
 IModel<Integer> model)

Constructor that will display the upload progress bar for every submit of the given form.

Parameters:

id - The component id

form - The form with the file upload fields

model - The initial value of the progress

UploadProgressBar

public UploadProgressBar(String id,
 Form<?> form,
 FileUploadField fileUploadField,
 IModel<Integer> model)

Constructor that will display the upload progress bar for the given file upload field.

Parameters:

id - The component id

form - The form with the file upload fields

fileUploadField - The file upload field which progress will be followed.

model - The initial value of the progress

Method Details

getCss

protected ResourceReference getCss()

Overrides:

getCss in class UploadProgressBar

striped

public boolean striped()

striped

public UploadProgressBar striped(boolean value)

active

public boolean active()

active

public UploadProgressBar active(boolean value)

color

public BackgroundColorBehavior.Color color()

color

public UploadProgressBar color(BackgroundColorBehavior.Color color)

newBarComponent

protected MarkupContainer newBarComponent(String id)

Overrides:

newBarComponent in class UploadProgressBar

newStatusComponent

protected MarkupContainer newStatusComponent(String id)

Overrides:

newStatusComponent in class UploadProgressBar

complete

public final boolean complete()

Returns whether the progress bar is complete or not.

Returns:

true if the progress bar is complete.

value

public UploadProgressBar value(IModel<Integer> value)

Sets a new value for the progress.

Returns:

this instance, for method chaining.

value

public UploadProgressBar value(Integer value)

Sets a new value for the progress.

Returns:

this instance, for method chaining.

value

public Integer value()

Returns the current value of the progress.

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 UploadProgressBar