|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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<T> org.apache.wicket.markup.html.form.FormComponentPanel<Collection<FileUpload>> org.apache.wicket.markup.html.form.upload.MultiFileUploadField
public class MultiFileUploadField
Form component that allows the user to select multiple files to upload via a single <input
type="file"/> field.
Notice that this component clears its model at the end of the request, so the uploaded files MUST
be processed within the request they were uploaded.
Uses javascript implementation from
http://the-stickman.com/web-development/javascript/upload-multiple
-files-with-a-single-file-element/
For customizing caption text see RESOURCE_LIMITED
and RESOURCE_UNLIMITED
For an example of styling using CSS see the upload example in wicket-examples
Field Summary | |
---|---|
static String |
RESOURCE_LIMITED
Resource key used to retrieve caption message for when a limit on the number of uploads is specified. |
static String |
RESOURCE_UNLIMITED
Resource key used to retrieve caption message for when no limit on the number of uploads is specified. |
static int |
UNLIMITED
Represents an unlimited max count of uploads |
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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER |
Constructor Summary | |
---|---|
MultiFileUploadField(String id)
Constructor |
|
MultiFileUploadField(String id,
IModel<? extends Collection<FileUpload>> model)
Constructor |
|
MultiFileUploadField(String id,
IModel<? extends Collection<FileUpload>> model,
int max)
Constructor |
|
MultiFileUploadField(String id,
int max)
Constructor |
Method Summary | |
---|---|
protected Collection<FileUpload> |
convertValue(String[] value)
Subclasses should overwrite this if the conversion is not done through the type field and the IConverter . |
String[] |
getInputAsArray()
Gets the request parameters for this component as strings. |
boolean |
isMultiPart()
|
protected void |
onBeforeRender()
Called just before a component is rendered. |
protected void |
onComponentTag(ComponentTag tag)
Processes the component tag. |
protected void |
onDetach()
Sets the temporary converted input value to null. |
void |
renderHead(IHeaderResponse response)
Render to the web response whatever the component wants to contribute to the head section. |
void |
updateModel()
See FormComponent.updateCollectionModel(FormComponent) for details on how the model
is updated. |
Methods inherited from class org.apache.wicket.markup.html.form.FormComponentPanel |
---|
checkRequired, newMarkupSourcingStrategy |
Methods inherited from class org.apache.wicket.markup.html.form.FormComponent |
---|
add, add, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isRequired, isValid, newValidatable, newValidationError, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, 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 |
---|
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int UNLIMITED
public static final String RESOURCE_LIMITED
public static final String RESOURCE_UNLIMITED
Constructor Detail |
---|
public MultiFileUploadField(String id)
id
- public MultiFileUploadField(String id, int max)
id
- max
- max number of files a user can uploadpublic MultiFileUploadField(String id, IModel<? extends Collection<FileUpload>> model)
id
- model
- public MultiFileUploadField(String id, IModel<? extends Collection<FileUpload>> model, int max)
id
- model
- max
- max number of files a user can uploadMethod Detail |
---|
protected void onComponentTag(ComponentTag tag)
FormComponentPanel
onComponentTag
in class FormComponentPanel<Collection<FileUpload>>
tag
- Tag to modifyFormComponentPanel.onComponentTag(org.apache.wicket.markup.ComponentTag)
protected void onBeforeRender()
Component
NOTE: If you override this, you *must* call super.onBeforeRender() within
your implementation.
Because this method is responsible for cascading Component.onBeforeRender()
call to its
children it is strongly recommended that super call is made at the end of the override.
onBeforeRender
in class Component
Component.onBeforeRender()
public boolean isMultiPart()
isMultiPart
in class FormComponent<Collection<FileUpload>>
public void renderHead(IHeaderResponse response)
Component
renderHead
in interface IHeaderContributor
renderHead
in class Component
response
- Response objectpublic String[] getInputAsArray()
FormComponent
getInputAsArray
in class FormComponent<Collection<FileUpload>>
FormComponent.getInputAsArray()
protected Collection<FileUpload> convertValue(String[] value) throws ConversionException
FormComponent
IConverter
. WARNING: this method may be removed in future versions.
If conversion fails then a ConversionException should be thrown
convertValue
in class FormComponent<Collection<FileUpload>>
value
- The value can be the getInput() or through a cookie
ConversionException
- If input can't be convertedFormComponent.convertValue(java.lang.String[])
public void updateModel()
FormComponent.updateCollectionModel(FormComponent)
for details on how the model
is updated.
updateModel
in interface IFormModelUpdateListener
updateModel
in class FormComponent<Collection<FileUpload>>
protected void onDetach()
FormComponent
onDetach
in class FormComponent<Collection<FileUpload>>
Component.onDetach()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |