de.alpharogroup.wicket.components.upload

Class UploadFilePanel

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<UploadFileModel>

de.alpharogroup.wicket.components.upload.UploadFilePanel

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<UploadFileModel>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public abstract class UploadFilePanel
extends org.apache.wicket.markup.html.panel.GenericPanel<UploadFileModel>

The Class UploadFilePanel.

Author:

Asterios Raptis

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

Constructors

Constructor and Description
UploadFilePanel(String id, org.apache.wicket.model.IModel<UploadFileModel> model) Instantiates a new upload file panel.

Method Summary

Modifier and Type	Method and Description
org.apache.wicket.markup.html.basic.Label	getButtonLabel() Gets the button label.
org.apache.wicket.markup.html.basic.Label	getFileInputLabel() Gets the file input label.
org.apache.wicket.markup.html.form.upload.FileUploadField	getFileUploadField() Gets the file upload field.
org.apache.wicket.markup.html.form.Form<?>	getForm() Gets the form.
org.apache.wicket.util.lang.Bytes	getMaxSize() Gets the max size.
org.apache.wicket.markup.html.form.Button	getSubmitButton() Gets the submit button.
protected org.apache.wicket.markup.html.form.Button	newButton(String id, org.apache.wicket.markup.html.form.Form<?> form) Factory method for creating the Button.
protected org.apache.wicket.markup.html.basic.Label	newButtonLabel(String id, String resourceKey, String defaultValue, org.apache.wicket.Component component) Factory method for creating the button Label.
protected org.apache.wicket.markup.html.basic.Label	newFileInputLabel(String id, String resourceKey, String defaultValue, org.apache.wicket.Component component) Factory method for creating the fileInput Label.
protected org.apache.wicket.markup.html.form.upload.FileUploadField	newFileUploadField(String id) Factory method for creating the FileUploadField.
protected org.apache.wicket.markup.html.form.Form<?>	newForm(String id, org.apache.wicket.model.IModel<?> model) Factory method for creating the Form.
protected org.apache.wicket.util.lang.Bytes	newMaxSize() Factory method for that sets the maximum size of the uploaded file.
protected org.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar	newUploadProgressBar(String id, org.apache.wicket.markup.html.form.Form<?> form, org.apache.wicket.markup.html.form.upload.FileUploadField uploadField) Factory method for creating the UploadProgressBar.
protected abstract void	onUpload(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form, boolean error) Template method that must be implemented from all derived classes.

Methods inherited from class org.apache.wicket.markup.html.panel.GenericPanel

getModel, getModelObject, setModel, setModelObject

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, onReAdd, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

UploadFilePanel

public UploadFilePanel(String id,
                       org.apache.wicket.model.IModel<UploadFileModel> model)

Instantiates a new upload file panel.

Parameters:

id - the id

model - the model

Method Detail

newFileInputLabel

protected org.apache.wicket.markup.html.basic.Label newFileInputLabel(String id,
                                                                      String resourceKey,
                                                                      String defaultValue,
                                                                      org.apache.wicket.Component component)

Factory method for creating the fileInput Label. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of the fileInput Label.

Parameters:

id - the id

resourceKey - the resource key

defaultValue - the default value

component - the component

Returns:

the label

newUploadProgressBar

protected org.apache.wicket.extensions.ajax.markup.html.form.upload.UploadProgressBar newUploadProgressBar(String id,
                                                                                                           org.apache.wicket.markup.html.form.Form<?> form,
                                                                                                           org.apache.wicket.markup.html.form.upload.FileUploadField uploadField)

Factory method for creating the UploadProgressBar. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a UploadProgressBar.

Parameters:

id - the id

form - the form

uploadField - the upload field

Returns:

the upload progress bar

newButtonLabel

protected org.apache.wicket.markup.html.basic.Label newButtonLabel(String id,
                                                                   String resourceKey,
                                                                   String defaultValue,
                                                                   org.apache.wicket.Component component)

Factory method for creating the button Label. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of the button Label.

Parameters:

id - the id

resourceKey - the resource key

defaultValue - the default value

component - the component

Returns:

the label

getFileInputLabel

public org.apache.wicket.markup.html.basic.Label getFileInputLabel()

Gets the file input label.

Returns:

the file input label

getFileUploadField

public org.apache.wicket.markup.html.form.upload.FileUploadField getFileUploadField()

Gets the file upload field.

Returns:

the file upload field

getButtonLabel

public org.apache.wicket.markup.html.basic.Label getButtonLabel()

Gets the button label.

Returns:

the button label

getForm

public org.apache.wicket.markup.html.form.Form<?> getForm()

Gets the form.

Returns:

the form

getSubmitButton

public org.apache.wicket.markup.html.form.Button getSubmitButton()

Gets the submit button.

Returns:

the submit button

getMaxSize

public org.apache.wicket.util.lang.Bytes getMaxSize()

Gets the max size.

Returns:

the max size

newButton

protected org.apache.wicket.markup.html.form.Button newButton(String id,
                                                              org.apache.wicket.markup.html.form.Form<?> form)

Factory method for creating the Button. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a Button.

Parameters:

id - the id

form - the form

Returns:

the button

newFileUploadField

protected org.apache.wicket.markup.html.form.upload.FileUploadField newFileUploadField(String id)

Factory method for creating the FileUploadField. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a FileUploadField.

Parameters:

id - the id

Returns:

the file upload field

newForm

protected org.apache.wicket.markup.html.form.Form<?> newForm(String id,
                                                             org.apache.wicket.model.IModel<?> model)

Factory method for creating the Form. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a Form.

Parameters:

id - the id

model - the model

Returns:

the form

newMaxSize

protected org.apache.wicket.util.lang.Bytes newMaxSize()

Factory method for that sets the maximum size of the uploaded file. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of the maximum size of the uploaded file.

Returns:

the bytes

onUpload

protected abstract void onUpload(org.apache.wicket.ajax.AjaxRequestTarget target,
                                 org.apache.wicket.markup.html.form.Form<?> form,
                                 boolean error)

Template method that must be implemented from all derived classes. Here comes the logic what shell happen when an upload is started. Note: Add the feedback to the target so the info and error messages will be displayed.

Parameters:

target - the target

form - the form

error - flag that indicates that an error occured.