org.wicketstuff.html5.fileapi

Class FileFieldChangeBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.behavior.AbstractAjaxBehavior

org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

org.apache.wicket.ajax.AjaxEventBehavior

org.wicketstuff.html5.fileapi.FileFieldChangeBehavior

All Implemented Interfaces:

Serializable, org.apache.wicket.behavior.IBehaviorListener, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

FileFieldSizeCheckBehavior

public abstract class FileFieldChangeBehavior
extends org.apache.wicket.ajax.AjaxEventBehavior

A Behavior that can be used on FileUploadField-s to receive ajax callback with detailed information about the chosen files when an event occurs (default: "onchange"). When the ajax call is triggered (for example user selects files for upload) the metadata about the file(s) (name, size, type, last modify date) is sent with the ajax call to the server (so the content is not). Subclasses of this class can respond to this event by implementing the onEvent(AjaxRequestTarget, FileList) method.

Works with single or multiple enabled file inputs.

Note that this behaviour only works with browsers implementing the Html5 FileApi (Chrome 11, Firefox 4). It does not change or break browsers not implementing the api.

Author:

akiraly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_NUM_OF_FILES Default maximum number of files that are processed from the ajax request: 100.
protected static org.apache.wicket.request.resource.ResourceReference	JAVASCRIPT_REF

Fields inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

INDICATOR

Fields inherited from interface org.apache.wicket.behavior.IBehaviorListener

INTERFACE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileFieldChangeBehavior() Default constructor: the monitored event is "onchange" and maxNumOfFiles is DEFAULT_MAX_NUM_OF_FILES.
	FileFieldChangeBehavior(int maxNumOfFiles) Constructor.
protected	FileFieldChangeBehavior(String event, int maxNumOfFiles) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxNumOfFiles() Returns the configured max.
protected void	onEvent(org.apache.wicket.ajax.AjaxRequestTarget target)
protected abstract void	onEvent(org.apache.wicket.ajax.AjaxRequestTarget target, FileList fileList) Called during the ajax callback.
void	renderHead(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)
protected void	updateAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)

Methods inherited from class org.apache.wicket.ajax.AjaxEventBehavior

getEvent, onCheckEvent, respond

Methods inherited from class org.apache.wicket.ajax.AbstractDefaultAjaxBehavior

findIndicatorId, getAttributes, getCallbackFunction, getCallbackFunctionBody, getCallbackScript, getCallbackScript, onBind, onRequest, postprocessConfiguration, renderAjaxAttributes, renderAjaxAttributes

Methods inherited from class org.apache.wicket.behavior.AbstractAjaxBehavior

afterRender, bind, getCallbackUrl, getComponent, onComponentRendered, onComponentTag, onComponentTag, onUnbind, unbind

Methods inherited from class org.apache.wicket.behavior.Behavior

beforeRender, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onConfigure, onEvent, onException, onRemove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JAVASCRIPT_REF

protected static final org.apache.wicket.request.resource.ResourceReference JAVASCRIPT_REF

DEFAULT_MAX_NUM_OF_FILES

public static final int DEFAULT_MAX_NUM_OF_FILES

Default maximum number of files that are processed from the ajax request: 100.

See Also:

Constant Field Values

Constructor Detail

FileFieldChangeBehavior

public FileFieldChangeBehavior()

Default constructor: the monitored event is "onchange" and maxNumOfFiles is DEFAULT_MAX_NUM_OF_FILES.

FileFieldChangeBehavior

public FileFieldChangeBehavior(int maxNumOfFiles)

Constructor. The monitored event is "onchange".

Parameters:

maxNumOfFiles - maximum number of files that are processed from the ajax request, non-negative

FileFieldChangeBehavior

protected FileFieldChangeBehavior(String event,
                       int maxNumOfFiles)

Constructor.

Parameters:

event - event for which the ajax call is triggered, not-null

maxNumOfFiles - maximum number of files that are processed from the ajax request, non-negative

Method Detail

renderHead

public void renderHead(org.apache.wicket.Component component,
              org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class org.apache.wicket.ajax.AjaxEventBehavior

onEvent

protected void onEvent(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

onEvent in class org.apache.wicket.ajax.AjaxEventBehavior

onEvent

protected abstract void onEvent(org.apache.wicket.ajax.AjaxRequestTarget target,
           FileList fileList)

Called during the ajax callback.

Parameters:

target - wicket object representing the ajax response, not-null

fileList - list of files chosen in the upload field, not-null

updateAjaxAttributes

protected void updateAjaxAttributes(org.apache.wicket.ajax.attributes.AjaxRequestAttributes attributes)

Overrides:

updateAjaxAttributes in class org.apache.wicket.ajax.AjaxEventBehavior

getMaxNumOfFiles

public int getMaxNumOfFiles()

Returns the configured max.

Returns:

maximum number of files that are processed from the ajax request, non-negative