EditableFileView

EditableFileView class

Signature:

export abstract class EditableFileView extends FileView 

Extends: FileView

Constructors

ConstructorModifiersDescription
(constructor)(leaf)

Constructs a new instance of the FileView class

(Inherited from FileView)

Properties

PropertyModifiersTypeDescription
allowNoFileboolean

(Inherited from FileView)

appApp

(Inherited from View)

containerElHTMLElement

(Inherited from View)

contentElHTMLElement

(Inherited from ItemView)

fileTFile | null

(Inherited from FileView)

iconIconName

(Inherited from View)

leafWorkspaceLeaf

(Inherited from View)

navigationboolean

File views can be navigated by default.

(Inherited from FileView)

scopeScope | null

Assign an optional scope to your view to register hotkeys for when the view is in focus.

(Inherited from View)

Methods

MethodModifiersDescription
addAction(icon, title, callback)

(Inherited from ItemView)

addChild(component)

Adds a child component, loading it if this component is loaded

(Inherited from Component)

canAcceptExtension(extension)

(Inherited from FileView)

getDisplayText()

(Inherited from FileView)

getEphemeralState()

(Inherited from View)

getIcon()

(Inherited from View)

getState()

(Inherited from FileView)

getViewType()abstract

(Inherited from View)

load()

Load this component and its children

(Inherited from Component)

onClose()protected

(Inherited from View)

onload()

(Inherited from FileView)

onLoadFile(file)

(Inherited from FileView)

onOpen()protected

(Inherited from View)

onPaneMenu(menu, source)

Populates the pane menu.

(Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)

(Inherited from View)

onRename(file)

(Inherited from FileView)

onResize()

Called when the size of this view is changed.

(Inherited from View)

onunload()

Override this to unload your component

(Inherited from Component)

onUnloadFile(file)

(Inherited from FileView)

register(cb)

Registers a callback to be called when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerEvent(eventRef)

Registers an event to be detached when unloading

(Inherited from Component)

registerInterval(id)

Registers an interval (from setInterval) to be cancelled when unloading Use instead of to avoid TypeScript confusing between NodeJS vs Browser API

(Inherited from Component)

removeChild(component)

Removes a child component, unloading it

(Inherited from Component)

setEphemeralState(state)

(Inherited from View)

setState(state, result)

(Inherited from FileView)

unload()

Unload this component and its children

(Inherited from Component)