API Docs for: 1.8.0
Show:

photonui.FileManager Class

Extends photonui.Base
Defined in: src/nonvisual/filemanager.js:41
Module: NonVisual
Parent Module: PhotonUI

Open files from the standard "FileOpen" dialog and drag & drop.

wEvents:

  • file-open:
    • description: File selected or dropped.
    • callback: function(widget, fileBlob, x, y) //(x=y=undefined if using a dialog)

Constructor

photonui.FileManager

(
  • params
)

Defined in src/nonvisual/filemanager.js:41

Parameters:

  • params Object

    An object that can contain any property of the widget (optional).

Methods

__onFileDropped

(
  • event
)
private

Defined in src/nonvisual/filemanager.js:276

Parameters:

__onFileSelected

(
  • event
)
private

Defined in src/nonvisual/filemanager.js:290

Parameters:

__onLocaleChanged

() private

Defined in src/nonvisual/filemanager.js:304

Called when the locale is changed.

_bindEvent

(
  • id
  • element
  • evName
  • callback
  • [options]
)
private

Inherited from photonui.Base: src/base.js:229

Javascript event binding (for internal use).

Parameters:

  • id String
    An unique id for the event.
  • element DOMElement
    The element on which the event will be bind.
  • evName String
    The event name (e.g. "mousemove", "click",...).
  • callback Function
    The function that will be called when the event occured.
  • [options] Object optional
    options for addEventListener

_callCallbacks

(
  • wEvent
  • params
)
private

Inherited from photonui.Base: src/base.js:292

Call all callbacks for the given wEvent. NOTE: the first argument passed to the callback is the current widget. NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.

Parameters:

  • wEvent String
    The widget event.
  • params Array
    Parametters that will be sent to the callbacks.

_openFile

(
  • file
  • x
  • y
)
private

Defined in src/nonvisual/filemanager.js:236

Check file and call callbacks.

Parameters:

  • file File
  • x Number

    The x postition of the mouse (d&d only).

  • y Number

    The y postition of the mouse (d&d only).

_registerWEvents

(
  • wEvents
)
private

Inherited from photonui.Base: src/base.js:276

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

Inherited from photonui.Base: src/base.js:257

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_updateAccepted

() private

Defined in src/nonvisual/filemanager.js:218

Update accepted mimes/extentions.

_updateProperties

(
  • properties
)
deprecated private

Inherited from photonui.Base: src/base.js:209

Force the update of the given properties. This method is deprecated. One should use '@photonui-update' abitbol's annotation on concerned properties.

Parameters:

  • properties Array
    The properties to update.

destroy

()

Inherited from photonui.Base but overwritten in src/nonvisual/filemanager.js:206

Destroy the class.

open

()

Defined in src/nonvisual/filemanager.js:193

Open the FileOpen dialog to allow user to browse its HDD for a file.

registerCallback

(
  • id
  • wEvent
  • callback
  • thisArg
)

Inherited from photonui.Base: src/base.js:169

Register a callback for any PhotonUI/Widget event (called wEvent). Callback signature: function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])

Parameters:

  • id String
    An unique id for the callback.
  • wEvent String
    the PhotonUI/Widget event name.
  • callback Function
    The callback function.
  • thisArg Object
    The value of this (optionnal, default = current widget).

removeCallback

(
  • id
)

Inherited from photonui.Base: src/base.js:193

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

Properties

__callbacks

Object private

Inherited from photonui.Base: src/base.js:142

Object containing references to registered callbacks.

__events

Object private

Inherited from photonui.Base: src/base.js:132

Object containing references javascript events binding (for widget internal use).

__fileField

HTMLElement private

Defined in src/nonvisual/filemanager.js:178

The file field for opening the file dialog.

acceptedExts

Array

Defined in src/nonvisual/filemanager.js:98

List of the accepted file extentions.

Default: []

acceptedMimes

Array

Defined in src/nonvisual/filemanager.js:80

List of the accepted mime types.

Default: []

data

Object

Inherited from photonui.Base: src/base.js:113

Arbitrary data

Default: {}

dropZone

HTMLElement

Defined in src/nonvisual/filemanager.js:116

Element that accepts file drop (null disable d&d support).

Default: null

multiselect

Boolean

Defined in src/nonvisual/filemanager.js:153

Allow multiselect in FileOpen dialog.

Default: false