Module wicket.bootstrap.extensions

Package de.agilecoders.wicket.extensions.markup.html.bootstrap.form.fileinput

Class BootstrapFileInputField

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<List<FileUpload>>

org.apache.wicket.markup.html.form.upload.FileUploadField

de.agilecoders.wicket.extensions.markup.html.bootstrap.form.fileinput.BootstrapFileInputField

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<List<FileUpload>,FormComponent<List<FileUpload>>>, IMetadataContext<Serializable,Component>, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class BootstrapFileInputField
extends FileUploadField

Integration with Bootstrap FileInput

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JQUERY_IDENTIFIER_UPLOAD_BUTTON_CLASS	Make sure that this class is inside the uploadClass config, otherwise the ajax behavior will not work!

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

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
BootstrapFileInputField(String id)	Constructor
BootstrapFileInputField(String id, IModel<List<FileUpload>> model)	Constructor
BootstrapFileInputField(String id, IModel<List<FileUpload>> model, FileInputConfig config)	Constructor

Method Summary

Modifier and Type	Method	Description
FileInputConfig	getConfig()
protected AjaxFormSubmitBehavior	newAjaxFormSubmitBehavior(String event)	Creates the special Ajax behavior that is used to upload the file(s) with Ajax by using the Upload button
protected void	onAfterSubmit(AjaxRequestTarget target)	A callback method that is called after successful file upload triggered by the usage of the Upload button.
protected void	onComponentTag(ComponentTag tag)
protected void	onConfigure()
protected void	onError(AjaxRequestTarget target)	A callback method that is called when there is an error during an Ajax file upload
protected void	onSubmit(AjaxRequestTarget target)	A callback method that is called on successful file upload triggered by the usage of the Upload button.
void	renderHead(IHeaderResponse response)

Methods inherited from class org.apache.wicket.markup.html.form.upload.FileUploadField

convertValue, forceCloseStreamsOnDetach, getFileUpload, getFileUploads, getInputAsArray, isMultiPart, onDetach, updateModel

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isFormParticipant, isInputNullable, isRequired, isValid, newValidatable, newValidationError, onBeforeRender, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateAutoLabels, updateCollectionModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

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, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, 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 java.lang.Iterable

forEach, spliterator

Field Details

JQUERY_IDENTIFIER_UPLOAD_BUTTON_CLASS

public static final String JQUERY_IDENTIFIER_UPLOAD_BUTTON_CLASS

Make sure that this class is inside the uploadClass config, otherwise the ajax behavior will not work!

See Also:

• Constant Field Values

Constructor Details

BootstrapFileInputField

public BootstrapFileInputField(String id)

Constructor

Parameters:

id - The component id

BootstrapFileInputField

public BootstrapFileInputField(String id,
 IModel<List<FileUpload>> model)

Constructor

Parameters:

id - The component id

model - The model that will store the uploaded files

BootstrapFileInputField

public BootstrapFileInputField(String id,
 IModel<List<FileUpload>> model,
 FileInputConfig config)

Constructor

Parameters:

id - The component id

model - The model that will store the uploaded files

config - The configuration for this file input

Method Details

getConfig

public FileInputConfig getConfig()

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class FileUploadField

newAjaxFormSubmitBehavior

protected AjaxFormSubmitBehavior newAjaxFormSubmitBehavior(String event)

Creates the special Ajax behavior that is used to upload the file(s) with Ajax by using the Upload button

Parameters:

event - The name of the JavaScript event that will trigger the Ajax upload

Returns:

The Ajax behavior for the file upload

onError

protected void onError(AjaxRequestTarget target)

A callback method that is called when there is an error during an Ajax file upload

Parameters:

target - The Ajax request handler

onSubmit

protected void onSubmit(AjaxRequestTarget target)

A callback method that is called on successful file upload triggered by the usage of the Upload button.

Parameters:

target - The Ajax request handler

onAfterSubmit

protected void onAfterSubmit(AjaxRequestTarget target)

A callback method that is called after successful file upload triggered by the usage of the Upload button.

Parameters:

target - the AjaxRequestTarget

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component