org.wisepersist.gwt.uploader.client.events.FileDialogStartHandler 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 file dialog start events are fired by
 * the Uploader component.  General usage is as follows:
 *  * uploader.setFileDialogStartHandler(new FileDialogStartHandler() {
 *    public boolean onFileDialogStart(FileDialogStartEvent event) {
 *       Window.alert("Starting the file selection dialog...");
 *       return true;
 *    }
 * });
 * 
 * Note that the 'fileDialogStart' is fired after selectFile for selectFiles is called. This
 * event is fired immediately before the File Selection Dialog window is displayed. However,
 * the event may not execute until after the Dialog window is closed.
 * 
 * See the documentation on the {@link FileDialogStartEvent} class for more details on the data
 * available when a file dialog start event occurs.
 *
 * @author [email protected]
 */
public interface FileDialogStartHandler {

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

}