org.wisepersist.gwt.uploader.client.events

Class UploadStartEvent

java.lang.Object

org.wisepersist.gwt.uploader.client.events.UploadEvent

org.wisepersist.gwt.uploader.client.events.UploadStartEvent

public class UploadStartEvent
extends UploadEvent

Provides access to the raw information provided by Uploader when an 'uploader start' event occurs. This class should not be instantiated directly, but instead you should create a UploadStartHandler and register it via the .Uploader#setUploadStartHandler(UploadStartHandler) method in order to access uploader start events.

Note that the 'uploadStart' event is called immediately before the file is uploaded. This event provides an opportunity to perform any last minute validation, add post params or do any other work before the file is uploaded.

The uploader can be cancelled by returning 'false' from uploadStart in the handler. If you return 'true' or do not return any value then the uploader proceeds. Returning 'false' will cause an uploadError event to fired.

Constructor Summary

Constructors

Constructor and Description
UploadStartEvent(File file) This constructor is intended for internal use only.

Method Summary

Methods inherited from class org.wisepersist.gwt.uploader.client.events.UploadEvent

getFile

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadStartEvent

public UploadStartEvent(File file)

This constructor is intended for internal use only. You should not create uploader start events directly, but instead should register a UploadStartHandler.

Parameters:

file - The native javascript object containing the details of the file being uploaded.