Uploader (Moxie Apps GWT Uploader 1.2.0 API)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.google.gwt.user.client.ui.Panel
    - - com.google.gwt.user.client.ui.ComplexPanel
      - com.google.gwt.user.client.ui.AbsolutePanel
        
        org.moxieapps.gwt.uploader.client.Uploader

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>
```
public class Uploader
extends com.google.gwt.user.client.ui.AbsolutePanel
```
The main GWT widget that can be constructed and then configured in order to add an uploader component into a GWT application. Basic usage is as follows:
```
 Uploader uploader = new Uploader()
    .setUploadURL("http://www.widgetcorp.com/uploads.php")
    .setButtonText("Click Here Yeah")
    .setButtonTextStyle(".redText { color: #FF0000; }")
    .setButtonWidth(100)
    .setButtonHeight(22)
    .setButtonCursor(Uploader.Cursor.HAND);
 RootPanel.get().add(uploader);
 
```
Normally you'll also want to respond to various events that the GWT uploader component can generate in order to notify the user about the progress and status of the uploader. E.g.
```
 uploader.setUploadProgressHandler(new UploadProgressHandler() {
   public boolean onUploadProgress(UploadProgressEvent uploadProgressEvent) {
     Window.alert("File progress: " + uploadProgressEvent.getFile().getName() + "\n" +
       NumberFormat.getPercentFormat().format(
         uploadProgressEvent.getBytesComplete() / uploadProgressEvent.getBytesTotal()
       ) + " Percent Complete"
     );
     return true;
   }
 });
 
```
Similar events are available for when the file dialog window is opened, when a new file is added to the queue, when an uploader is started/completed, when errors occur, etc.
Internally the GWT Uploader component defaults to attempting to use the browser's DOM and XMLHttpRequest Level 2 mechanisms to manage the file selection, tracking of the various events, and handling the uploader of the file to the server. However, some browsers don't support the XMLHttpRequest Level 2 API (most notably of which is Internet Explorer). In that case the uploader component automatically detects that the browser support is not available and then transparently switches over to using a SWFUpload/Flash based mechanism for handling the file selection and uploader process instead. More details on the browsers which support the XMLHttpRequest Level 2 APIs can be found here. And additional details on the SWFUpload project can be found here. Note that if you only want to use the SWFUpload mechanism, independent of whether or not the browser supports the XMLHttpRequest Level 2 API, you can use the setAjaxUploadEnabled(boolean) method to disable the XMLHttpRequest Level 2 approach - in which case the GWT Uploader API serves essentially as a GWT wrapper for the SWFUpload JS API.
Author:

squinn@moxiegroup.com (Shawn Quinn)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Uploader.ButtonAction` An enumeration of supported button action types, which can be passed to the `setButtonAction(ButtonAction)` method.
`static class`	`Uploader.Cursor` An enumeration of supported button cursor types, which can be passed to the `setButtonCursor(Cursor)` method.
`static class`	`Uploader.WindowMode` An enumeration of supported button window types, which can be passed to the `setButtonWindowMode(WindowMode)` method.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel
com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description
`Uploader()` Create a new Uploader component that can be added to a GWT application, setting up an element in the DOM that the uploader button elements will be rendered inside of.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFilesToQueue(com.google.gwt.core.client.JsArray files)` When implementing drag/drop support for file uploads, this method can be used to pass into the uploader the list of native file references that the user dropped onto the application to be uploaded.
`void`	`cancelUpload()` Cancel the first file in the queue.
`void`	`cancelUpload(boolean triggerErrorEvent)` Cancel the first file in the queue.
`void`	`cancelUpload(String fileId)` Cancel the the file with the supplied id.
`void`	`cancelUpload(String fileId, boolean triggerErrorEvent)` Cancel the file upload for a specific file and remove from the queue.
`boolean`	`getButtonDisabled()` Returns whether or not the button has been set in a disabled state via the `setButtonDisabled(boolean)` method.
`com.google.gwt.json.client.JSONObject`	`getCustomSettings()` Returns the custom settings that were stored on this uploader component instance via the `setCustomSettings(JSONObject)` method.
`static com.google.gwt.core.client.JsArray`	`getDroppedFiles(com.google.gwt.dom.client.NativeEvent event)` A convenience method that can be used to extract the files that a user dropped on the application during a GWT drop event.
`Stats`	`getStats()` Returns the overall general statistics being tracked by the Uploader component, or null if the widget has not yet been added to the DOM.
`static boolean`	`isAjaxUploadWithProgressEventsSupported()` Returns true if the browser appears to support an HTML5 style upload (via the XMLHttpRequest Level 2 API).
`protected void`	`onLoad()`
`protected void`	`onUnload()`
`Uploader`	`setAjaxUploadEnabled(boolean ajaxUploadEnabled)` By default the component will attempt to use a DOM based Ajax uploader process if it detects that the browser can support the necessary requirements of the "XMLHttpRequest Level 2".
`Uploader`	`setAjaxUploadURL(String ajaxUploadURL)` By default both the XMLHttpRequest Level 2/Ajax uploads and the SWFUpload/Flash uploads will be posted to whatever URL is specified via the `setUploadURL(String)` method.
`Uploader`	`setAssumeSuccessTimeout(long assumeSuccessTimeout)` Convenience method for setting the 'assume_success_timeout' option of the component.
`Uploader`	`setButtonAction(Uploader.ButtonAction buttonAction)` Convenience method for setting the 'button_action' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonCursor(Uploader.Cursor cursor)` Convenience method for setting the 'button_cursor' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonDisabled(boolean buttonDisabled)` Convenience method for setting the 'button_disabled' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonHeight(int buttonHeight)` Convenience method for setting the 'button_height' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonImageURL(String buttonImageURL)` Convenience method for setting the 'button_image_url' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonText(String buttonText)` Convenience method for setting the 'button_text' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonTextLeftPadding(int buttonTextLeftPadding)` Convenience method for setting the 'button_text_left_padding' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonTextStyle(String buttonTextStyle)` Convenience method for setting the 'button_text_style' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonTextTopPadding(int buttonTextTopPadding)` Convenience method for setting the 'button_text_top_padding' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonWidth(int buttonWidth)` Convenience method for setting the 'button_width' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setButtonWindowMode(Uploader.WindowMode buttonWindowMode)` Convenience method for setting the 'button_window_mode' option of the component.
`Uploader`	`setCustomSettings(com.google.gwt.json.client.JSONObject customSettings)` Convenience method for setting the 'custom_settings' option of the component.
`Uploader`	`setDebug(boolean debug)` Convenience method for setting the 'debug' option of the component.
`Uploader`	`setFileDialogCompleteHandler(FileDialogCompleteHandler fileDialogCompleteHandler)` Set a callback handler that will be invoked whenever a file dialog complete event is fired.
`Uploader`	`setFileDialogStartHandler(FileDialogStartHandler fileDialogStartHandler)` Set a callback handler that will be invoked whenever a file dialog start event is fired.
`Uploader`	`setFilePostName(String filePostName)` Convenience method for setting the 'file_post_name' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFileQueuedHandler(FileQueuedHandler fileQueuedHandler)` Set a callback handler that will be invoked whenever a file queued event is fired.
`Uploader`	`setFileQueueErrorHandler(FileQueueErrorHandler fileQueueErrorHandler)` Set a callback handler that will be invoked whenever a file queue error event is fired.
`Uploader`	`setFileQueueLimit(long fileQueueLimit)` Convenience method for setting the 'file_queue_limit' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFileSizeLimit(String fileSizeLimit)` Convenience method for setting the 'file_size_limit' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFileTypes(String fileTypes)` Convenience method for setting the 'file_types' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFileTypesDescription(String fileTypesDescription)` Convenience method for setting the 'file_types_description' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFileUploadLimit(long fileUploadLimit)` Convenience method for setting the 'file_upload_limit' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setFlashURL(String flashURL)` Overrides the default "flash_url" setting.
`Uploader`	`setHttpSuccess(Long... httpSuccess)` Convenience method for setting the 'http_success' option of the component.
`Uploader`	`setOption(String path, Object value)` General purpose method to set an option on the SWFUpload object at any level, using "/" characters to designate which level of option you'd like to set.
`Uploader`	`setPostParams(com.google.gwt.json.client.JSONObject postParams)` Convenience method for setting the 'post_params' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setPreserveRelativeURLs(boolean preserveRelativeURLs)` Convenience method for setting the 'preserve_relative_urls' option of the component.
`Uploader`	`setPreventSWFCaching(boolean preventSWFCaching)` Convenience method for setting the 'prevent_swf_caching' option of the component.
`Uploader`	`setRequeueOnError(boolean requeueOnError)` Convenience method for setting the 'requeue_on_error' option of the component.
`Uploader`	`setSWFUploadLoadedHandler(SWFUploadLoadedHandler swfUploadLoadedHandler)` Set a callback handler that will be invoked whenever a Uploader loaded event is fired.
`Uploader`	`setUploadCompleteHandler(UploadCompleteHandler uploadCompleteHandler)` Set a callback handler that will be invoked whenever an uploader complete event is fired.
`Uploader`	`setUploadErrorHandler(UploadErrorHandler uploadErrorHandler)` Set a callback handler that will be invoked whenever an uploader error event is fired.
`Uploader`	`setUploadProgressHandler(UploadProgressHandler uploadProgressHandler)` Set a callback handler that will be invoked whenever an uploader progress event is fired.
`Uploader`	`setUploadStartHandler(UploadStartHandler uploadStartHandler)` Set a callback handler that will be invoked whenever an uploader start event is fired.
`Uploader`	`setUploadSuccessHandler(UploadSuccessHandler uploadSuccessHandler)` Set a callback handler that will be invoked whenever an uploader success event is fired.
`Uploader`	`setUploadURL(String uploadURL)` Convenience method for setting the 'upload_url' option of the component, either before or after the widget has been added to the DOM.
`Uploader`	`setUseQueryString(boolean useQueryString)` Convenience method for setting the 'use_query_string' option of the component, either before or after the widget has been added to the DOM.
`void`	`startUpload()` Cause the first file in the queue to start the uploader process
`void`	`startUpload(String fileId)` Cause the file with the specified Id to start the uploader process.

Methods inherited from class com.google.gwt.user.client.ui.AbsolutePanel
add, add, add, getWidgetLeft, getWidgetTop, insert, insert, insert, remove, setWidgetPosition, setWidgetPositionImpl

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget
add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel
getWidget, getWidgetCount, getWidgetIndex, remove

- Constructor Detail
  - Uploader
```
public Uploader()
```
    Create a new Uploader component that can be added to a GWT application, setting up an element in the DOM that the uploader button elements will be rendered inside of.
- Method Detail
  - setUploadURL
```
public Uploader setUploadURL(String uploadURL)
```
    Convenience method for setting the 'upload_url' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("upload_url", "http://www.widgetcorp.com/uploads.php");
 
```
    The upload_url setting accepts a full, absolute, or relative target URL for the uploaded file. Relative URLs should be relative to the document. The upload_url should be in the same domain as the SWFUploader Flash Control for best compatibility in browsers that don't support the XMLHttpRequest Level 2 API.
    In the case that the SWFUpload/Flash control is used if the setPreserveRelativeURLs(boolean) setting is false (the default) Uploader will convert the relative URL to an absolute URL to avoid the URL being interpreted differently by the Flash Player on different platforms. If you disable SWFUploads conversion of the URL relative URLs should be relative to the uploader.swf file.
    By default both the XMLHttpRequest Level 2/Ajax uploads and the SWFUpload/Flash uploads will be posted to whatever URL is specified via this method. However, if you'd like the Ajax uploads to be posted to a different URL than the SWF uploads, you can call the setAjaxUploadURL(String) method to set a unique URL for the Ajax uploads (and then only the SWF uploads will use the general "uploadURL").
    Parameters:
    uploadURL - The value to set as the 'upload_url' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setAjaxUploadURL
```
public Uploader setAjaxUploadURL(String ajaxUploadURL)
```
    By default both the XMLHttpRequest Level 2/Ajax uploads and the SWFUpload/Flash uploads will be posted to whatever URL is specified via the setUploadURL(String) method. However, if you'd like the Ajax uploads to be posted to a different URL than the SWF uploads, you can call this method to set a unique URL for the Ajax uploads (and then only the SWF uploads will use the general "uploadURL").
    
    Parameters:
    ajaxUploadURL - The URL that only the Ajax uploads should be posted to (or null to uploader both the Ajax and SWF uploads to whatever the setUploadURL(String) option has been set to.)
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setAjaxUploadEnabled
```
public Uploader setAjaxUploadEnabled(boolean ajaxUploadEnabled)
```
    By default the component will attempt to use a DOM based Ajax uploader process if it detects that the browser can support the necessary requirements of the "XMLHttpRequest Level 2". And then, only if the browser can not support the "XMLHttpRequest Level 2" mechanism will the component failover to using the Flash based SWFUpload mechanism instead. However, if you wish to only use the SWFUpload mechanism, then this option can be disabled.
    
    Parameters:
    ajaxUploadEnabled - By default ajax uploader is enabled and will be used as long as the browser supports the "XMLHttpRequest Level 2" object. Setting this option to "false" will instead force the component to avoid using the Ajax approach and instead utilize the SWFUpload/Flash technique only.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFilePostName
```
public Uploader setFilePostName(String filePostName)
```
    Convenience method for setting the 'file_post_name' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_post_name", "Filedata");
 
```
    The file_post_name allows you to set the value name used to post the file. This is not related to the file name. The default value is 'Filedata'. For maximum compatibility it is recommended that the default value is used.
    Parameters:
    filePostName - The value to set as the 'file_post_name' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setPostParams
```
public Uploader setPostParams(com.google.gwt.json.client.JSONObject postParams)
```
    Convenience method for setting the 'post_params' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     JSONObject params = new JSONObject();
     params.put("post_param_name_1", new JSONString("post_param_value_1"));
     params.put("post_param_name_2", new JSONString("post_param_value_2"));
     params.put("post_param_name_n", new JSONString("post_param_value_n"));
     uploader.setOption("post_params", params);
 
```
    The post_params setting defines the name/value pairs that will be posted with each uploaded file. This setting accepts a simple JavaScript object. Multiple post name/value pairs should be defined as demonstrated in the sample settings object. Values must be either strings or numbers (as interpreted by the JavaScript typeof function).
    Note: Flash Player 8 does not support sending additional post parameters. SWFUpload will automatically send the post_params as part of the query string.
    Parameters:
    postParams - The value to set as the 'post_params' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUseQueryString
```
public Uploader setUseQueryString(boolean useQueryString)
```
    Convenience method for setting the 'use_query_string' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("use_query_string", false);
 
```
    The use_query_string setting may be true or false. This value indicates whether Uploader should send the post_params and file params on the query string or the post.
    Note that this option only applies when the SWFUpload/Flash component is rendered. When the DHTML/Ajax mode is being used (the default) the params are always passed as part of the post.
    Parameters:
    useQueryString - The value to set as the 'use_query_string' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setPreserveRelativeURLs
```
public Uploader setPreserveRelativeURLs(boolean preserveRelativeURLs)
```
    Convenience method for setting the 'preserve_relative_urls' option of the component. Equivalent to:
```
     uploader.setOption("preserve_relative_urls", false);
 
```
    A boolean value that indicates whether Uploader should attempt to convert relative URLs used by the Flash Player to absolute URLs. If set to true Uploader will not modify any URLs. The default value is false.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    Parameters:
    preserveRelativeURLs - The value to set as the 'preserve_relative_urls' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setRequeueOnError
```
public Uploader setRequeueOnError(boolean requeueOnError)
```
    Convenience method for setting the 'requeue_on_error' option of the component. Equivalent to:
```
     uploader.setOption("requeue_on_error", true);
 
```
    The requeue_on_error setting may be true or false. When this setting is true any files that has an uploadError (excluding fileQueue errors and the FILE_CANCELLED uploadError) is returned to the front of the queue rather than being discarded. The file can be uploaded again if needed. To remove the file from the queue the cancelUpload method must be called.
    All the events associated with a failed uploader are still called and so the requeuing the failed uploader can conflict with the Queue Plugin (or custom code that uploads the entire queue). Code that automatically uploads the next file in the queue will uploader the failed file over and over again if care is not taken to allow the failing uploader to be cancelled.
    Parameters:
    requeueOnError - The value to set as the 'requeue_on_error' option on the Uploader component (default: false).
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setHttpSuccess
```
public Uploader setHttpSuccess(Long... httpSuccess)
```
    Convenience method for setting the 'http_success' option of the component. Equivalent to:
```
     uploader.setOption("http_success", new Long[] { 200L, 203L });
 
```
    An array that defines the HTTP Status Codes that will trigger success. 200 is always a success. Also, only the 200 status code provides the serverData.
    When returning and accepting an HTTP Status Code other than 200 it is not necessary for the server to return content.
    Parameters:
    httpSuccess - The values to set as the HTTP response codes to treat as a successful response (default: 200).
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setAssumeSuccessTimeout
```
public Uploader setAssumeSuccessTimeout(long assumeSuccessTimeout)
```
    Convenience method for setting the 'assume_success_timeout' option of the component. Equivalent to:
```
     uploader.setOption("assume_success_timeout", 1000);
 
```
    The number of seconds SWFUpload should wait for Flash to detect the server's response after the file has finished uploading. This setting allows you to work around the Flash Player bugs where long running server side scripts causes Flash to ignore the server response or the Mac Flash Player bug that ignores server responses with no content.
    Testing has shown that Flash will ignore server responses that take longer than 30 seconds after the last uploadProgress event.
    A timeout of zero (0) seconds disables this feature and is the default value. SWFUpload will wait indefinitely for the Flash Player to trigger the uploadSuccess event.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    Parameters:
    assumeSuccessTimeout - The value to set as the 'assume_success_timeout' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileTypes
```
public Uploader setFileTypes(String fileTypes)
```
    Convenience method for setting the 'file_types' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_types", "*.jpg;*.gif");
 
```
    The file_types setting accepts a semi-colon separated list of file extensions that are allowed to be selected by the user. Use '*.*' to allow all file types.
    Parameters:
    fileTypes - A semi-colon delimited list of file types that the file dialog should allow the user to select.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileTypesDescription
```
public Uploader setFileTypesDescription(String fileTypesDescription)
```
    Convenience method for setting the 'file_types_description' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_types_description", "Web Photos");
 
```
    A text description that is displayed to the user in the File Browser dialog.
    Parameters:
    fileTypesDescription - A text description that is displayed to the user in the File Browser dialog.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileSizeLimit
```
public Uploader setFileSizeLimit(String fileSizeLimit)
```
    Convenience method for setting the 'file_size_limit' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_size_limit", "5 MB");
 
```
    The file_size_limit setting defines the maximum allowed size of a file to be uploaded. This setting accepts a value and unit. Valid units are B, KB, MB and GB.
    Examples: 2147483648 B, 2097152, 2097152KB, 2048 MB, 2 GB
    If the unit is omitted default is KB. A value of 0 (zero) is interpreted as unlimited.
    Note: This setting only applies to the user's browser. It does not affect any settings or limits on the web server.
    Parameters:
    fileSizeLimit - The maximum allowed size of a file to be uploaded.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileUploadLimit
```
public Uploader setFileUploadLimit(long fileUploadLimit)
```
    Convenience method for setting the 'file_upload_limit' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_upload_limit", 10);
 
```
    Defines the number of files allowed to be uploaded by the uploader component. This setting also sets the upper bound of the file_queue_limit setting. Once the user has uploaded or queued the maximum number of files she will no longer be able to queue additional files. The value of 0 (zero) is interpreted as unlimited. Only successful uploads (uploads the trigger the uploadSuccess event) are counted toward the uploader limit.
    Note: This value is not tracked across pages and is reset when a page is refreshed. File quotas should be managed by the web server.
    Parameters:
    fileUploadLimit - The number of files allowed to be uploaded by the uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileQueueLimit
```
public Uploader setFileQueueLimit(long fileQueueLimit)
```
    Convenience method for setting the 'file_queue_limit' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("file_queue_limit", 10);
 
```
    Defines the number of unprocessed files allowed to be simultaneously queued. Once a file is uploaded, errored, or cancelled new files can be queued in its place until the queue limit has been reached. If the uploader limit (or remaining uploads allowed) is less than the queue limit then the lower number is used.
    Parameters:
    fileQueueLimit - The number of unprocessed files allowed to be simultaneously queued.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFlashURL
```
public Uploader setFlashURL(String flashURL)
```
    Overrides the default "flash_url" setting. Normally you'll want to leave this setting alone as the "uploader.swf" path will be automatically determined for you based on the GWT module path. However, if you've deployed the "uploader.swf" somewhere else (or on a different domain) then you can set the URL to the file here in order to override the default internal logic.
    The full, absolute, or relative URL to the Flash Control swf file. This setting cannot be changed once the Uploader has been instantiated. Relative URLs are relative to the page URL.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    
    Parameters:
    flashURL - The value to set as the 'flash_url' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setPreventSWFCaching
```
public Uploader setPreventSWFCaching(boolean preventSWFCaching)
```
    Convenience method for setting the 'prevent_swf_caching' option of the component. Equivalent to:
```
     uploader.setOption("prevent_swf_caching", false);
 
```
    This boolean setting indicates whether a random value should be added to the Flash URL in an attempt to prevent the browser from caching the SWF movie. This works around a bug in some IE-engine based browsers.
    Note: The algorithm for adding the random number to the URL is dumb and cannot handle URLs that already have some parameters.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    Parameters:
    preventSWFCaching - The value to set as the 'prevent_swf_caching' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setDebug
```
public Uploader setDebug(boolean debug)
```
    Convenience method for setting the 'debug' option of the component. Equivalent to:
```
     uploader.setOption("debug", false);
 
```
    A boolean value that defines whether the debug event handler should be fired.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    Parameters:
    debug - The value to set as the 'debug' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonImageURL
```
public Uploader setButtonImageURL(String buttonImageURL)
```
    Convenience method for setting the 'button_image_url' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_image_url", "http://widgetcorp.com/upload_button.png");
 
```
    Fully qualified, absolute or relative URL to the image file to be used as the button's image.
    This URL is affected by the preserve_relative_urls setting and should follow the same rules as the upload_url setting.
    The button image is treated as a sprite. There are 4 button states that must be represented by the button image. Each button state image should be stacked above the other in this order: normal, hover, down/click, disabled.
    Parameters:
    buttonImageURL - The URL to the image file to be used as the button's image.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonWidth
```
public Uploader setButtonWidth(int buttonWidth)
```
    Convenience method for setting the 'button_width' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_width", 62);
 
```
    A number defining the width of the uploader button.
    Parameters:
    buttonWidth - The value to set as width of the uploader button.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonHeight
```
public Uploader setButtonHeight(int buttonHeight)
```
    Convenience method for setting the 'button_height' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_height", 21);
 
```
    A number defining the height of the uploader button.
    Parameters:
    buttonHeight - The value to set as height of the uploader button.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonText
```
public Uploader setButtonText(String buttonText)
```
    Convenience method for setting the 'button_text' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_text", "Click here");
 
```
    Plain or HTML text that is displayed over the uploader button. HTML text can be further styled using CSS classes and the button_text_style setting, but should be limited to what Flash can support for compatibility with browsers that don't support the XMLHttpRequest Level 2 API. See Adobe's Flash documentation for details.
    Parameters:
    buttonText - Plain or HTML text that is displayed over the uploader button.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonTextStyle
```
public Uploader setButtonTextStyle(String buttonTextStyle)
```
    Convenience method for setting the 'button_text_style' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_text_style", ".redText { color: #FF0000; }");
 
```
    CSS style string that defines how the button_text is displayed. Should be limited to what Flash can support for compatibility with browsers that don't support the XMLHttpRequest Level 2 API. See Adobe's Flash documentation for details.
    Parameters:
    buttonTextStyle - The CSS style string that defines how the button text is displayed.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonTextTopPadding
```
public Uploader setButtonTextTopPadding(int buttonTextTopPadding)
```
    Convenience method for setting the 'button_text_top_padding' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_text_top_padding", 2);
 
```
    Used to vertically position the button text within the uploader component. Negative values may be used.
    Parameters:
    buttonTextTopPadding - The amount of padding to include between the outer bounds of the uploader component and the top of the text.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonTextLeftPadding
```
public Uploader setButtonTextLeftPadding(int buttonTextLeftPadding)
```
    Convenience method for setting the 'button_text_left_padding' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_text_left_padding", 2);
 
```
    Used to horizontally position the button text within the uploader component. Negative values may be used.
    Parameters:
    buttonTextLeftPadding - The amount of padding to include between the outer bounds of the uploader component and the left of the text.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonAction
```
public Uploader setButtonAction(Uploader.ButtonAction buttonAction)
```
    Convenience method for setting the 'button_action' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_action", ButtonAction.SELECT_FILES);
 
```
    Defines the action to take when the uploader component is clicked.
    Parameters:
    buttonAction - The action to take when the uploader component is clicked.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonDisabled
```
public Uploader setButtonDisabled(boolean buttonDisabled)
```
    Convenience method for setting the 'button_disabled' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_disabled", false);
 
```
    A boolean value that sets whether the uploader button is in the disabled state. When in the disabled state the button will not execute any actions.
    Parameters:
    buttonDisabled - Whether the uploader button is in the disabled state.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - getButtonDisabled
```
public boolean getButtonDisabled()
```
    Returns whether or not the button has been set in a disabled state via the setButtonDisabled(boolean) method.
    
    Returns:
    'true' if the button has been disabled (e.g. grayed out), or 'false' if the button is still enabled.
  - setButtonCursor
```
public Uploader setButtonCursor(Uploader.Cursor cursor)
```
    Convenience method for setting the 'button_cursor' option of the component, either before or after the widget has been added to the DOM. Equivalent to:
```
     uploader.setOption("button_cursor", Cursor.HAND);
 
```
    Used to define what type of mouse cursor is displayed when hovering over the uploader component.
    Parameters:
    cursor - The type of cursor to display when the mouse is hovering over the uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setButtonWindowMode
```
public Uploader setButtonWindowMode(Uploader.WindowMode buttonWindowMode)
```
    Convenience method for setting the 'button_window_mode' option of the component. Equivalent to:
```
     uploader.setOption("button_window_mode", WindowMode.TRANSPARENT);
 
```
    Sets the WMODE property of the Flash Movie.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    Parameters:
    buttonWindowMode - The value to set as the 'button_window_mode' option on the Uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setCustomSettings
```
public Uploader setCustomSettings(com.google.gwt.json.client.JSONObject customSettings)
```
    Convenience method for setting the 'custom_settings' option of the component. Equivalent to:
```
     JSONObject settings = new JSONObject();
     settings.put("My Setting", new JSONString("This is my setting"));
     settings.put("myothersetting", new JSONString("This is my other setting"));
     settings.put("integer_setting", new JSONNumber(100));
     uploader.setOption("custom_settings", settings);
 
```
    The custom_settings setting allows developers to safely attach additional information to a uploader instance without worrying about affecting internal values or changes in new GWT Uploader (or SWFUpload) versions. This setting accepts a JSON object.
    Once instantiated the custom settings are accessed via the getCustomSettings() method.
    Parameters:
    customSettings - The value to set as the 'custom_settings' option on the uploader component.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - getCustomSettings
```
public com.google.gwt.json.client.JSONObject getCustomSettings()
```
    Returns the custom settings that were stored on this uploader component instance via the setCustomSettings(JSONObject) method. The custom_settings setting allows developers to safely attach additional information to a uploader instance without worrying about affecting internal values or changes in new GWT Uploader (or SWFUpload) versions.
    
    Returns:
    JSONObject
  - getStats
```
public Stats getStats()
```
    Returns the overall general statistics being tracked by the Uploader component, or null if the widget has not yet been added to the DOM.
    
    Returns:
    Stats
  - setSWFUploadLoadedHandler
```
public Uploader setSWFUploadLoadedHandler(SWFUploadLoadedHandler swfUploadLoadedHandler)
```
    Set a callback handler that will be invoked whenever a Uploader loaded event is fired.
    Note that this option only applies when the SWFUpload/Flash component is rendered.
    
    Parameters:
    swfUploadLoadedHandler - The handler that should be invoked whenever a Uploader loaded event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileDialogStartHandler
```
public Uploader setFileDialogStartHandler(FileDialogStartHandler fileDialogStartHandler)
```
    Set a callback handler that will be invoked whenever a file dialog start event is fired.
    
    Parameters:
    fileDialogStartHandler - The handler that should be invoked whenever a file dialog start event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileQueuedHandler
```
public Uploader setFileQueuedHandler(FileQueuedHandler fileQueuedHandler)
```
    Set a callback handler that will be invoked whenever a file queued event is fired.
    
    Parameters:
    fileQueuedHandler - The handler that should be invoked whenever a file queued event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileQueueErrorHandler
```
public Uploader setFileQueueErrorHandler(FileQueueErrorHandler fileQueueErrorHandler)
```
    Set a callback handler that will be invoked whenever a file queue error event is fired.
    
    Parameters:
    fileQueueErrorHandler - The handler that should be invoked whenever a file queue error event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setFileDialogCompleteHandler
```
public Uploader setFileDialogCompleteHandler(FileDialogCompleteHandler fileDialogCompleteHandler)
```
    Set a callback handler that will be invoked whenever a file dialog complete event is fired.
    
    Parameters:
    fileDialogCompleteHandler - The handler that should be invoked whenever a file dialog complete event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUploadCompleteHandler
```
public Uploader setUploadCompleteHandler(UploadCompleteHandler uploadCompleteHandler)
```
    Set a callback handler that will be invoked whenever an uploader complete event is fired.
    
    Parameters:
    uploadCompleteHandler - The handler that should be invoked whenever an uploader complete event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUploadErrorHandler
```
public Uploader setUploadErrorHandler(UploadErrorHandler uploadErrorHandler)
```
    Set a callback handler that will be invoked whenever an uploader error event is fired.
    
    Parameters:
    uploadErrorHandler - The handler that should be invoked whenever an uploader error event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUploadProgressHandler
```
public Uploader setUploadProgressHandler(UploadProgressHandler uploadProgressHandler)
```
    Set a callback handler that will be invoked whenever an uploader progress event is fired.
    
    Parameters:
    uploadProgressHandler - The handler that should be invoked whenever an uploader progress event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUploadStartHandler
```
public Uploader setUploadStartHandler(UploadStartHandler uploadStartHandler)
```
    Set a callback handler that will be invoked whenever an uploader start event is fired.
    
    Parameters:
    uploadStartHandler - The handler that should be invoked whenever an uploader start event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setUploadSuccessHandler
```
public Uploader setUploadSuccessHandler(UploadSuccessHandler uploadSuccessHandler)
```
    Set a callback handler that will be invoked whenever an uploader success event is fired.
    
    Parameters:
    uploadSuccessHandler - The handler that should be invoked whenever an uploader success event occurs.
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - setOption
```
public Uploader setOption(String path,
                 Object value)
```
    General purpose method to set an option on the SWFUpload object at any level, using "/" characters to designate which level of option you'd like to set. E.g., the following code:
```
 Uploader uploader = new Uploader();
 uploader.setOption("/upload_url", "http://widgetcorp.com/uploads.php");
 uploader.setOption("/post_params/upload_type", "Photo Upload");
 uploader.setOption("/post_params/user_id", "User 24");
 
```
    Would result in initializing the SWFUpload component like the following:
```
 new SWFUpload({
     upload_url: "http://widgetcorp.com/uploads.php",
     post_params: {
         upload_type: "Photo Upload",
         user_id: "User 24"
     }
 });
 
```
    Note that the beginning "/" is optional, so uploader.setOption("/thing", "piglet") is equivalent to uploader.setOption("thing", "piglet").
    For details on available options see the SWFUpload reference.
    Important note: this method is only intended to support additional options of the SWFUpload API that may not have explicit wrapper methods available in the GWT Uploader API. For all of the standard configuration options it is important to use the appropriate setter methods instead in order for the Ajax/DOM implementation to function properly as well. E.g. instead of doing this:
```
 uploader.setOption("upload_url", "http://widgetcorp.com/uploads.php");
 
```
    Do this instead:
```
 uploader.setUploadURL("http://widgetcorp.com/uploads.php");
 
```
    Parameters:
    path - The path to the option to set (e.g. "/title/text");
    value - The value to set for the option (can be a String, Number, Boolean, or JSONObject)
    
    Returns:
    A reference to this Uploader instance for convenient method chaining.
  - startUpload
```
public void startUpload()
```
    Cause the first file in the queue to start the uploader process
  - startUpload
```
public void startUpload(String fileId)
```
    Cause the file with the specified Id to start the uploader process. Note that currently this method is only available when the SWFUpload/Flash component is used to handle the upload.
    
    Parameters:
    fileId - The id of the file the begin uploading
  - cancelUpload
```
public void cancelUpload(String fileId,
                boolean triggerErrorEvent)
```
    Cancel the file upload for a specific file and remove from the queue.
    
    Parameters:
    fileId - The fileId to cancel
    triggerErrorEvent - if true, an uploadError event will be issued
  - cancelUpload
```
public void cancelUpload()
```
    Cancel the first file in the queue.
  - cancelUpload
```
public void cancelUpload(String fileId)
```
    Cancel the the file with the supplied id. An uploadError event will be issued.
    
    Parameters:
    fileId - The fileId to cancel
  - cancelUpload
```
public void cancelUpload(boolean triggerErrorEvent)
```
    Cancel the first file in the queue.
    
    Parameters:
    triggerErrorEvent - if true, an uploadError event will be issued
  - isAjaxUploadWithProgressEventsSupported
```
public static boolean isAjaxUploadWithProgressEventsSupported()
```
    Returns true if the browser appears to support an HTML5 style upload (via the XMLHttpRequest Level 2 API).
    Logic adapted from: http://blog.new-bamboo.co.uk/2012/01/10/ridiculously-simple-ajax-uploads-with-formdata
    
    Returns:
    'true' if an HTML5 style upload can be used, or 'false' if a Flash style upload (utilizing the SWFUpload library) is the only available option.
  - onLoad
```
protected void onLoad()
```
    Overrides:
    
    onLoad in class com.google.gwt.user.client.ui.Widget
  - addFilesToQueue
```
public void addFilesToQueue(com.google.gwt.core.client.JsArray files)
```
    When implementing drag/drop support for file uploads, this method can be used to pass into the uploader the list of native file references that the user dropped onto the application to be uploaded. Will normally be used in conjunction with the getDroppedFiles(com.google.gwt.dom.client.NativeEvent) method. E.g.
```
 final Uploader uploader = new Uploader();
 dropFilesArea.addDropHandler(new DropHandler() {
    public void onDrop(DropEvent event) {
       event.preventDefault();
       uploader.addFilesToQueue(
          Uploader.getDroppedFiles(event.getNativeEvent())
       );
    }
 });
 
```
    Parameters:
    files - An array of native file references to be added to the queue.
  - getDroppedFiles
```
public static com.google.gwt.core.client.JsArray getDroppedFiles(com.google.gwt.dom.client.NativeEvent event)
```
    A convenience method that can be used to extract the files that a user dropped on the application during a GWT drop event. Useful when adding drag/drop support for file uploads to your application. E.g.
```
 final Uploader uploader = new Uploader();
 dropFilesArea.addDropHandler(new DropHandler() {
    public void onDrop(DropEvent event) {
       event.preventDefault();
       uploader.addFilesToQueue(
          Uploader.getDroppedFiles(event.getNativeEvent())
       );
    }
 });
 
```
    Parameters:
    event - The native event provided by GWT that was fired when the drop occurred
    
    Returns:
    An array of native file references that were dropped as part of the event, which can subsequently be passed to the addFileToQueue(com.google.gwt.core.client.JavaScriptObject) method.
  - onUnload
```
protected void onUnload()
```
    Overrides:
    
    onUnload in class com.google.gwt.user.client.ui.Widget

Class Uploader

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.user.client.ui.AbsolutePanel

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

Methods inherited from class com.google.gwt.user.client.ui.Panel

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

Constructor Detail

Uploader

Method Detail

setUploadURL

setAjaxUploadURL

setAjaxUploadEnabled

setFilePostName

setPostParams

setUseQueryString

setPreserveRelativeURLs

setRequeueOnError

setHttpSuccess

setAssumeSuccessTimeout

setFileTypes

setFileTypesDescription

setFileSizeLimit

setFileUploadLimit

setFileQueueLimit

setFlashURL

setPreventSWFCaching

setDebug

setButtonImageURL

setButtonWidth

setButtonHeight

setButtonText

setButtonTextStyle

setButtonTextTopPadding

setButtonTextLeftPadding

setButtonAction

setButtonDisabled

getButtonDisabled

setButtonCursor

setButtonWindowMode

setCustomSettings

getCustomSettings

getStats

setSWFUploadLoadedHandler

setFileDialogStartHandler

setFileQueuedHandler

setFileQueueErrorHandler

setFileDialogCompleteHandler

setUploadCompleteHandler

setUploadErrorHandler

setUploadProgressHandler

setUploadStartHandler

setUploadSuccessHandler

setOption

startUpload

startUpload

cancelUpload

cancelUpload

cancelUpload

cancelUpload

isAjaxUploadWithProgressEventsSupported

onLoad

addFilesToQueue

getDroppedFiles

onUnload