org.wisepersist.gwt.uploader.client.events.UploadProgressHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwt-uploader Show documentation

GWT Uploader is a freely available open source GWT library that encapsulates the file upload capabilities provided by the File and XMLHttpRequest Level 2 APIs as well as the SWFUpload library.

There is a newer version: 1.2.3

Show newest version

/*
 * Copyright (c) 2016 WisePersist.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wisepersist.gwt.uploader.client.events;

/**
 * An interface that can be used as a callback handler when uploader progress events are fired by
 * the Uploader component.  General usage is as follows:
 *  * uploader.setUploadProgressHandler(new UploadProgressHandler() {
 *    public boolean onUploadProgress(UploadProgressEvent event) {
 *       Window.alert("Uploader progressed to " + event.getBytesTotal() + " bytes");
 *       return true;
 *    }
 * });
 * 
 * 
 * Note that the 'uploadProgress' event is fired periodically by the Flash Control. This event is
 * useful for providing UI updates on the page.
 * 

 * Note: The Linux Flash Player fires a single uploadProgress event after the entire file has
 * been uploaded.
 * This is a bug in the Linux Flash Player that we cannot work around.
 * 
 * See the documentation on the {@link UploadProgressEvent} class for more details on the data
 * available when a progress event occurs.
 *
 * @author [email protected]
 */
public interface UploadProgressHandler {

  /**
   * This method is fired whenever a progress event occurs in the Uploader component.  See
   * the {@link UploadProgressEvent} class for more details on the data available when this event
   * is fired.
   *
   * @param uploadProgressEvent The details of the event that occurred.
   * @return The response to send back to the event handler function
   */
  public boolean onUploadProgress(UploadProgressEvent uploadProgressEvent);

}