dojox/form/Uploader.js

• Provides:

  • dojox.form.Uploader

• Requires:

  • dojox.form.uploader.Base in common
  • dijit.form.Button in common

• dojox.form.Uploader

  • type

    Function

  • chains:
    • dojox.form.uploader.Base: (prototype)
    • dojox.form.uploader.Base: (call)
  • summary

    A widget that creates a stylable file-input button, with optional multi-file selection,
    using only HTML elements. Non-HTML5 browsers have fallback options of Flash or an iframe.

  • description

    A bare-bones, stylable file-input button, with optional multi-file selection. The list
    of files is not displayed, that is for you to handle by connecting to the onChange
    event, or use the dojox.form.uploader.FileList.
    
    Uploader without plugins does not have any ability to upload - it is for use in forms
    where you handle the upload either by a standard POST or with Ajax using an iFrame. This
    class is for convenience of multiple files only. No progress events are available.
    
    If the browser supports a file-input with the "multiple" attribute, that will be used.
    If the browser does not support "multiple" (ergo, IE) multiple inputs are used,
    one for each selection.

• dojox.form.Uploader.uploadOnSelect

  • type

    Boolean

  • summary

    If true, uploads imediately after a file has been selected. If false,
    waits for upload() to be called.

• dojox.form.Uploader.tabIndex

  • type

    Number|String

  • summary

    The tab order in the DOM.

• dojox.form.Uploader.multiple

  • type

    Boolean

  • summary

    If true and flash mode, multiple files may be selected from the dialog.

• dojox.form.Uploader.label

  • type

    String

  • summary

    The text used in the button that when clicked, opens a system Browse Dialog.

• dojox.form.Uploader.url

  • type

    String

  • summary

    The url targeted for upload. An absolute URL is preferred. Relative URLs are
    changed to absolute.

• dojox.form.Uploader.name

  • type

    String

  • summary

    The name attribute needs to end with square brackets: [] as this is the standard way
    of handling an attribute "array". This requires a slightly different technique on the
    server.

• dojox.form.Uploader.flashFieldName

  • type

    String

  • summary

    If set, this will be the name of the field of the flash uploaded files that the server
    is expecting. If not set, "Flash" is appended to the "name" property.

• dojox.form.Uploader.uploadType

  • type

    String

  • summary

    [readonly]
    The type of uploader being used. As an alternative to determining the upload type on the
    server based on the fieldName, this property could be sent to the server to help
    determine what type of parsing should be used.

• dojox.form.Uploader._nameIndex

  • type

    Number

• dojox.form.Uploader.widgetsInTemplate

  • type

    Object

• dojox.form.Uploader.templateString

  • type

    String

• dojox.form.Uploader.postMixInProperties

  • type

    Function

• dojox.form.Uploader._inputs

  • type

    Array

• dojox.form.Uploader.postCreate

  • type

    Function

• dojox.form.Uploader.domNode.parentNode

• dojox.form.Uploader.onChange

  • parameters:
    • fileArray: (typeof Array)
  • summary

    stub to connect
    Fires when files are selected
    Event is an array of last files selected

  • type

    Function

• dojox.form.Uploader.onBegin

  • parameters:
    • dataArray: (typeof Array)
  • summary

    Fires when upload begins

  • type

    Function

• dojox.form.Uploader.onProgress

  • parameters:
    • customEvent: (typeof Object)

      bytesLoaded: Number
      Amount of bytes uploaded so far of entire payload (all files)
      bytesTotal: Number
      Amount of bytes of entire payload (all files)
      type: String
      Type of event (progress or load)
      timeStamp: Number
      Timestamp of when event occurred

  • summary

    Stub to connect
    Fires on upload progress. Event is a normalized object of common properties
    from HTML5 uploaders and the Flash uploader. Will not fire for IFrame.

  • type

    Function

• dojox.form.Uploader.onComplete

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

    stub to connect
    Fires when all files have uploaded
    Event is an array of all files

  • type

    Function

• dojox.form.Uploader.onCancel

  • summary

    Stub to connect
    Fires when dialog box has been closed
    without a file selection

  • type

    Function

• dojox.form.Uploader.onAbort

  • summary

    Stub to connect
    Fires when upload in progress was canceled

  • type

    Function

• dojox.form.Uploader.onError

  • parameters:
    • evtObject: (typeof Object)

      or String

  • summary

    Fires on errors
    
    FIXME: Unsure of a standard form of error events

  • type

    Function

• dojox.form.Uploader.upload

  • parameters:
    • formData: (typeof Object)

      ?

  • summary

    When called, begins file upload. Only supported with plugins.

  • type

    Function

• dojox.form.Uploader.submit

  • parameters:
    • form: (typeof form)

      Node ?

  • summary

    If Uploader is in a form, and other data should be sent along with the files, use
    this instead of form submit. Only supported with plugins.

  • type

    Function

• dojox.form.Uploader.reset

  • type

    Function

• dojox.form.Uploader.getFileList

  • returns

    Array

  • summary

    Returns a list of selected files.

  • type

    Function

• dojox.form.Uploader._getValueAttr

  • summary

    Internal. To get disabled use: uploader.get("disabled");

  • type

    Function

• dojox.form.Uploader._setValueAttr

  • parameters:
    • disabled
  • type

    Function

• dojox.form.Uploader._getDisabledAttr

  • summary

    Internal. To get disabled use: uploader.get("disabled");

  • type

    Function

• dojox.form.Uploader._setDisabledAttr

  • parameters:
    • disabled
  • summary

    Internal. To set disabled use: uploader.set("disabled", true);

  • type

    Function

• dojox.form.Uploader._getNodePosition

  • parameters:
    • node
  • type

    Function

• dojox.form.Uploader._getButtonStyle

  • parameters:
    • node
  • type

    Function

• dojox.form.Uploader.btnSize

  • type

    Object

• dojox.form.Uploader._setButtonStyle

  • type

    Function

• dojox.form.Uploader.inputNodeFontSize

  • type

    Object

• dojox.form.Uploader._createInput

  • type

    Function

• dojox.form.Uploader.inputNode

  • type

    Object

• dojox.form.Uploader._connectButton

  • type

    Function

• dojox.form.Uploader._cons

  • type

    Array

• dojox.form.Uploader.inputNode.tabIndex

• dojox.form.Uploader._disconnectButton

  • type

    Function

• dojox.form.UploaderOrg

  • alias - dojox.form.Uploader

• dojox.form.addUploaderPlugin

  • parameters:
    • plug
  • summary

    Handle Uploader plugins. When the dojox.form.addUploaderPlugin() function is called,
    the dojox.form.Uploader is recreated using the new plugin (mixin).

  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object