ve.FileExplorer

ve.Component. ve.FileExplorer

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

File explorer used either for navigation (i.e. saving/loading) or as a generic file explorer primitive.

  • Functional binding: veFileExplorer().
Constructor:
  • arg0_value: string - The file path in which the FileExplorer should be initialised.
  • arg1_options: Object
    • .file_components_obj={select: ...}: Object<ve.Component>
    • .file_icon="<icon>description</icon>": string
    • .file_options: Object
    • .folder_components_obj={select: ...}: Object<ve.Component>
    • .folder_icon="<icon>folder</icon>": string
    • .folder_options: Object
    • .name: string
    • .navigation_only=false: boolean
Instance:
  • .clipboard: Array<string> - The list of full file paths currently stored in the clipboard.
  • .selected: Array<string> - The list of selected file paths.
  • .v: string - Accessor. The current file path.
Methods:
  • clearClipboard()
  • deselect(arg0_file_path:string, arg1_options:{do_not_modify_classes: boolean}) | Array<string>
  • deselectAll()
  • fireSelectToggle(v:boolean, e:ve.Toggle) - Internal handler for toggling file/folder selection.
  • select(arg0_file_path:string) | Array<string>
  • selectAll()
  • setClipboard() - Sets the clipboard to currently selected file paths.
  • refresh() - Refreshes the current ve.FileExplorer display. Handled automatically.
  • getFiles(arg0_file_paths:Array<string>) | Array<string> - Returns all the subpaths in the set of file/folder paths given.
  • copy(arg0_file_paths:Array<string>, arg1_file_path:string, arg2_function:function) - Opens a copy files modal with a callback function.
  • delete(arg0_file_paths:Array<string>, arg1_file_path:string, arg2_function:function) - Opens a delete files modal with a callback function.
  • move(arg0_file_paths:Array<string>, arg1_file_path:string, arg2_function:function) - Opens a move files modal with a callback function.
  • rename(arg0_file_path:string, arg1_function:function) - Opens a rename file modal with a callback function.

Constructor

new ve.FileExplorer()

Source:

Extends

Members

clipboard :Array.<string>

Contains all file paths currently in the clipboard.

Source:
Type:
  • Array.<string>

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

selected :Array.<string>

Contains all currently selected file paths.

Source:
Type:
  • Array.<string>

Methods

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array