dojox/form/FileInputAuto.js

• Provides:

  • dojox.form.FileInputAuto

• Requires:

  • dojox.form.FileInput in common
  • dojo.io.iframe in common

• dojox.form.FileInputAuto

  • type

    Function

  • chains:
    • dojox.form.FileInput: (prototype)
    • dojox.form.FileInput: (call)
  • summary

    An extension on dojox.form.FileInput providing background upload progress

  • description

    An extended version of FileInput - when the user focuses away from the input
    the selected file is posted via dojo.io.iframe to the url. example implementation
    comes with PHP solution for handling upload, and returning required data.
    
    notes: the return data from the io.iframe is used to populate the input element with
    data regarding the results. it will be a JSON object, like:
    
    results = { size: "1024", filename: "file.txt" }
    
    all the parameters allowed to dojox.form.FileInput apply

• dojox.form.FileInputAuto.url

  • type

    String

  • summary

    the URL where our background FileUpload will be sent

• dojox.form.FileInputAuto.blurDelay

  • type

    Integer

  • summary

    time in ms before an un-focused widget will wait before uploading the file to the url="" specified
    default: 2 seconds

• dojox.form.FileInputAuto.duration

  • type

    Integer

  • summary

    The time in ms to use as the generic timing mechanism for the animations
    set to 1 or 0 for "immediate respose"

• dojox.form.FileInputAuto.uploadMessage

  • type

    String

  • summary

    FIXME: i18n somehow?

• dojox.form.FileInputAuto.triggerEvent

  • type

    String

  • summary

    Event which triggers the upload. Defaults to onblur, sending the file selected
    'blurDelay' milliseconds after losing focus. Set to "onchange" with a low blurDelay
    to send files immediately after uploading.

• dojox.form.FileInputAuto._sent

  • type

    bool

• dojox.form.FileInputAuto.templateString

  • type

    Object

• dojox.form.FileInputAuto.onBeforeSend

  • summary

    Called immediately before a FileInput sends it's file via io.iframe.send.
    The return of this function is passed as the <code>content</code> member in the io.iframe IOArgs
    object.

  • type

    Function

• dojox.form.FileInputAuto.startup

  • summary

    add our extra blur listeners

  • type

    Function

• dojox.form.FileInputAuto._blurListener

  • type

    Object

• dojox.form.FileInputAuto._focusListener

  • type

    Object

• dojox.form.FileInputAuto._onFocus

  • summary

    clear the upload timer

  • type

    Function

• dojox.form.FileInputAuto._onBlur

  • summary

    start the upload timer

  • type

    Function

• dojox.form.FileInputAuto._blurTimer

  • type

    Object

• dojox.form.FileInputAuto.setMessage

  • parameters:
    • title: (typeof String)
  • summary

    set the text of the progressbar

  • type

    Function

• dojox.form.FileInputAuto._sendFile

  • parameters:
    • e: (typeof Event)
  • summary

    triggers the chain of events needed to upload a file in the background.

  • type

    Function

• dojox.form.FileInputAuto._sending

  • type

    bool

• dojox.form.FileInputAuto._handleSend

  • parameters:
    • data
    • ioArgs
  • summary

    The callback to toggle the progressbar, and fire the user-defined callback

  • type

    Function

• dojox.form.FileInputAuto.overlay.style.backgroundImage

  • type

    String

• dojox.form.FileInputAuto.fileInput.style.display

  • type

    String

• dojox.form.FileInputAuto.fakeNodeHolder.style.display

  • type

    String

• dojox.form.FileInputAuto.fileInput

  • type

    Object

• dojox.form.FileInputAuto.reset

  • parameters:
    • e
  • summary

    accomodate our extra focusListeners

  • type

    Function

• dojox.form.FileInputAuto.overlay.style.display

  • type

    String

• dojox.form.FileInputAuto.onComplete

  • parameters:
    • data: (typeof the)

      raw data found in the first [TEXTAREA] tag of the post url

    • ioArgs: (typeof the)

      dojo.Deferred data being passed from the handle: callback

    • widgetRef: (typeof this)

      widget pointer, so you can set this.overlay to a completed/error message easily

  • summary

    stub function fired when an upload has finished.

  • type

    Function

• dojox.form.FileInputBlind

  • type

    Function

  • chains:
    • dojox.form.FileInputAuto: (prototype)
    • dojox.form.FileInputAuto: (call)
  • summary

    An extended version of dojox.form.FileInputAuto
    that does not display an input node, but rather only a button
    and otherwise behaves just like FileInputAuto

• dojox.form.FileInputBlind.startup

  • summary

    hide our fileInput input field

  • type

    Function

• dojox.form.FileInputBlind._off

  • type

    Object

• dojox.form.FileInputBlind.inputNode.style.display

  • type

    String

• dojox.form.FileInputBlind._fixPosition

  • summary

    in this case, set the button under where the visible button is

  • type

    Function

• dojox.form.FileInputBlind.reset

  • parameters:
    • e
  • summary

    onclick, we need to reposition our newly created input type="file"

  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object