TextFileView - Developer Documentation

[`TextFileView`](TextFileView) ## TextFileView class This class implements a plaintext-based editable file view, which can be loaded and saved given an editor. Note that by default, this view only saves when it's closing. To implement auto-save, your editor should call `this.requestSave()` when the content is changed. **Signature:** ```typescript export abstract class TextFileView extends EditableFileView ``` **Extends:** [`EditableFileView`](EditableFileView) ## Constructors | Constructor | Modifiers | Description | | --- | --- | --- | | [`(constructor)(leaf)`](TextFileView/(constructor).md) | | Constructs a new instance of the <code>TextFileView</code> class | ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [`allowNoFile`](FileView/allowNoFile) | | <code>boolean</code> | (Inherited from [FileView](FileView)) | | [`app`](View/app) | | [`App`](App) | (Inherited from [View](View)) | | [`containerEl`](View/containerEl) | | <code>HTMLElement</code> | (Inherited from [View](View)) | | [`contentEl`](ItemView/contentEl) | | <code>HTMLElement</code> | (Inherited from [ItemView](ItemView)) | | [`data`](TextFileView/data) | | <code>string</code> | In memory data | | [`file`](FileView/file) | | [`TFile`](TFile)<code> | null</code> | (Inherited from [FileView](FileView)) | | [`icon`](View/icon) | | [`IconName`](IconName) | (Inherited from [View](View)) | | [`leaf`](View/leaf) | | [`WorkspaceLeaf`](WorkspaceLeaf) | (Inherited from [View](View)) | | [`navigation`](FileView/navigation) | | <code>boolean</code> | File views can be navigated by default. (Inherited from [FileView](FileView)) | | [`requestSave`](TextFileView/requestSave) | | <code>() => void</code> | Debounced save in 2 seconds from now | | [`scope`](View/scope) | | [`Scope`](Scope)<code> | null</code> | Assign an optional scope to your view to register hotkeys for when the view is in focus.(Inherited from [View](View)) | ## Methods | Method | Modifiers | Description | | --- | --- | --- | | [`addAction(icon, title, callback)`](ItemView/addAction) | | (Inherited from [ItemView](ItemView)) | | [`addChild(component)`](Component/addChild) | | Adds a child component, loading it if this component is loaded(Inherited from [Component](Component)) | | [`canAcceptExtension(extension)`](FileView/canAcceptExtension) | | (Inherited from [FileView](FileView)) | | [`clear()`](TextFileView/clear) | <code>abstract</code> | Clear the editor. This is usually called when we're about to open a completely different file, so it's best to clear any editor states like undo-redo history, and any caches/indexes associated with the previous file contents. | | [`getDisplayText()`](FileView/getDisplayText) | | (Inherited from [FileView](FileView)) | | [`getEphemeralState()`](View/getEphemeralState) | | (Inherited from [View](View)) | | [`getIcon()`](View/getIcon) | | (Inherited from [View](View)) | | [`getState()`](FileView/getState) | | (Inherited from [FileView](FileView)) | | [`getViewData()`](TextFileView/getViewData) | <code>abstract</code> | Gets the data from the editor. This will be called to save the editor contents to the file. | | [`getViewType()`](View/getViewType) | <code>abstract</code> | (Inherited from [View](View)) | | [`load()`](Component/load) | | Load this component and its children(Inherited from [Component](Component)) | | [`onClose()`](View/onClose) | <code>protected</code> | (Inherited from [View](View)) | | [`onload()`](FileView/onload) | | (Inherited from [FileView](FileView)) | | [`onLoadFile(file)`](TextFileView/onLoadFile) | | | | [`onOpen()`](View/onOpen) | <code>protected</code> | (Inherited from [View](View)) | | [`onPaneMenu(menu, source)`](View/onPaneMenu) | | Populates the pane menu.(Replaces the previously removed <code>onHeaderMenu</code> and <code>onMoreOptionsMenu</code>)(Inherited from [View](View)) | | [`onRename(file)`](FileView/onRename) | | (Inherited from [FileView](FileView)) | | [`onResize()`](View/onResize) | | Called when the size of this view is changed.(Inherited from [View](View)) | | [`onunload()`](Component/onunload) | | Override this to unload your component(Inherited from [Component](Component)) | | [`onUnloadFile(file)`](TextFileView/onUnloadFile) | | | | [`register(cb)`](Component/register) | | Registers a callback to be called when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent_1) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerDomEvent(el, type, callback, options)`](Component/registerDomEvent_2) | | Registers an DOM event to be detached when unloading(Inherited from [Component](Component)) | | [`registerEvent(eventRef)`](Component/registerEvent) | | Registers an event to be detached when unloading(Inherited from [Component](Component)) | | [`registerInterval(id)`](Component/registerInterval) | | 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](Component)) | | [`removeChild(component)`](Component/removeChild) | | Removes a child component, unloading it(Inherited from [Component](Component)) | | [`save(clear)`](TextFileView/save) | | | | [`setEphemeralState(state)`](View/setEphemeralState) | | (Inherited from [View](View)) | | [`setState(state, result)`](FileView/setState) | | (Inherited from [FileView](FileView)) | | [`setViewData(data, clear)`](TextFileView/setViewData) | <code>abstract</code> | Set the data to the editor. This is used to load the file contents.If clear is set, then it means we're opening a completely different file. In that case, you should call clear(), or implement a slightly more efficient clearing mechanism given the new data to be set. | | [`unload()`](Component/unload) | | Unload this component and its children(Inherited from [Component](Component)) |