dojox/form/uploader/plugins/Flash.js

• Provides:

  • dojox.form.uploader.plugins.Flash

• Requires:

  • dojox.form.uploader.plugins.HTML5 in common
  • dojox.embed.flashVars in common
  • dojox.embed.Flash in common

• dojox.form.uploader.plugins.Flash

  • type

    Function

  • summary

    A plugin for dojox.form.Uploader that utilizes a Flash SWF for handling to upload in IE.
    All other browsers will use the HTML5 plugin, unless force="flash" is used, then Flash
    will be used in all browsers. force="flash"	is provided because Flash has some features
    that HTML5 does not yet have. But it is still not recommended because of the many problems
    that Firefox and Webkit have with the Flash plugin.

  • description

    Inherits all properties from dojox.form.Uploader and dojox.form.uploader.plugins.HTML5.
    All properties and methods listed here are specific to the Flash plugin only.

• dojox.form.uploader.plugins.Flash.swfPath

  • type

    String

  • summary

    Path to SWF. Can be overwritten or provided in djConfig.

• dojox.form.uploader.plugins.Flash.skipServerCheck

  • type

    Boolean

  • summary

    If true, will not verify that the server was sent the correct format.
    This can be safely set to true. The purpose of the server side check
    is mainly to show the dev if they've implemented the different returns
    correctly.

• dojox.form.uploader.plugins.Flash.serverTimeout

  • type

    Number

  • summary

    (milliseconds)
    The amount of time given to the uploaded file
    to wait for a server response. After this amount
    of time, the onComplete is fired but with a 'server timeout'
    error in the returned item.

• dojox.form.uploader.plugins.Flash.isDebug

  • type

    Boolean

  • summary

    If true, outputs traces from the SWF to console. What exactly gets passed
    is very relative, and depends upon what traces have been left in the DEFT SWF.

• dojox.form.uploader.plugins.Flash.devMode

  • type

    Boolean.

  • summary

    Re-implemented. devMode increases the logging, adding style tracing from the SWF.

• dojox.form.uploader.plugins.Flash.deferredUploading

  • type

    Number

  • summary

    (1 - X)
    (Flash only) throttles the upload to a certain amount of files at a time.
    By default, Flash uploads file one at a time to the server, but in parallel.
    Firefox will try to queue all files at once, leading to problems. Set this
    to the amount to upload in parallel at a time.
    Generally, 1 should work fine, but you can experiment with queuing more than
    one at a time.
    This is of course ignored if selectMultipleFiles equals false.

• dojox.form.uploader.plugins.Flash.force

  • type

    String

  • summary

    Use "flash" to always use Flash (and hopefully force the user to download the plugin
    if they don't have it).

• dojox.form.uploader.plugins.Flash.postMixInProperties

  • type

    Function

• dojox.form.uploader.plugins.Flash.uploadType

  • type

    String

• dojox.form.uploader.plugins.Flash._files

  • type

    Object

• dojox.form.uploader.plugins.Flash._fileMap

  • type

    Object

• dojox.form.uploader.plugins.Flash._createInput

• dojox.form.uploader.plugins.Flash.getFileList

• dojox.form.uploader.plugins.Flash.reset

• dojox.form.uploader.plugins.Flash.upload

• dojox.form.uploader.plugins.Flash.submit

• dojox.form.uploader.plugins.Flash.fieldname

  • type

    String

• dojox.form.uploader.plugins.Flash.onReady

  • parameters:
    • uploader: (typeof dojox.form.FileUploader)
  • summary

    Stub - Fired when dojox.embed.Flash has created the
    Flash object, but it has not necessarilly finished
    downloading, and is ready to be communicated with.

  • type

    Function

• dojox.form.uploader.plugins.Flash.onLoad

  • parameters:
    • uploader: (typeof dojox.form.FileUploader)
  • summary

    Stub - SWF has been downloaded 100%.

  • type

    Function

• dojox.form.uploader.plugins.Flash.onFileChange

  • parameters:
    • fileArray
  • summary

    Stub - Flash-specific event. Fires on each selection of files
    and only provides the files selected on that event - not all files
    selected, as with HTML5

  • type

    Function

• dojox.form.uploader.plugins.Flash.onFileProgress

  • parameters:
    • fileArray
  • summary

    Stub - Flash-specific event. Fires on progress of upload
    and only provides a file-specific event

  • type

    Function

• dojox.form.uploader.plugins.Flash.getFlashFileList

  • returns

    Array

  • summary

    Returns list of currently selected files

  • type

    Function

• dojox.form.uploader.plugins.Flash.flashReset

  • type

    Function

• dojox.form.uploader.plugins.Flash.uploadFlash

  • summary

    Uploads selected files. Alias "upload()" should be used instead.

  • tags:
  • type

    Function

• dojox.form.uploader.plugins.Flash.submitFlash

  • parameters:
    • formParams: (typeof Object)
  • summary

    Uploads selected files with form data. Alias "submit()" should be used instead.

  • tags:
  • type

    Function

• dojox.form.uploader.plugins.Flash._change

  • parameters:
    • fileArray
  • type

    Function

• dojox.form.uploader.plugins.Flash._complete

  • parameters:
    • fileArray
  • type

    Function

• dojox.form.uploader.plugins.Flash._progress

  • parameters:
    • f
  • type

    Function

• dojox.form.uploader.plugins.Flash._error

  • parameters:
    • err
  • type

    Function

• dojox.form.uploader.plugins.Flash._onFlashBlur

  • parameters:
    • fileArray
  • type

    Function

• dojox.form.uploader.plugins.Flash._getCustomEvent

  • returns

    Object

  • type

    Function

• dojox.form.uploader.plugins.Flash._connectFlash

  • summary

    Subscribing to published topics coming from the
    Flash uploader.

  • description

    Sacrificing some readbilty for compactness. this.id
    will be on the beginning of the topic, so more than
    one uploader can be on a page and can have unique calls.

  • type

    Function

• dojox.form.uploader.plugins.Flash._subs

  • type

    Array

• dojox.form.uploader.plugins.Flash._cons

  • type

    Array

• dojox.form.uploader.plugins.Flash._createFlashUploader

  • summary

    Internal. Creates Flash Uploader

  • type

    Function

• dojox.form.uploader.plugins.Flash.inputNode

  • type

    Object

• dojox.form.uploader.plugins.Flash.btnSize.w

• dojox.form.uploader.plugins.Flash.btnSize.h

• dojox.form.uploader.plugins.Flash.flashObject

  • type

    Object

• dojox.form.uploader.plugins.Flash.flashObject.onError

  • type

    Object

• dojox.form.uploader.plugins.Flash.flashObject.onReady

  • type

    Object

• dojox.form.uploader.plugins.Flash.flashObject.onLoad

  • type

    Object

• dojox.form.uploader.plugins

  • type

    Object

• dojox.form.uploader

  • type

    Object

• dojox.form

  • type

    Object

• dojox

  • type

    Object