Namespace Commands

A utility class for adding commands and menu items, for use by the File Editor extension or other Editor extensions.

Index

Functions

Functions

addAutoClosingBracketsCommand

addAutoClosingBracketsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void

- Defined in packages/fileeditor-extension/src/commands.ts:429
Add the Auto Close Brackets for Text Editor command

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
Returns void

addChangeFontSizeCommand

addChangeFontSizeCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void

- Defined in packages/fileeditor-extension/src/commands.ts:266
Add a command to change font size for File Editor

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
Returns void

addChangeFontSizeCommandsToPalette

addChangeFontSizeCommandsToPalette(palette: ICommandPalette, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1131
Add commands to change the font size to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addChangeTabsCommand

addChangeTabsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string): void

- Defined in packages/fileeditor-extension/src/commands.ts:366
Add command for changing tabs size or type in File Editor

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
Returns void

addChangeTabsCommandsToPalette

addChangeTabsCommandsToPalette(palette: ICommandPalette, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1077
Add commands to change the tab indentation to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addCodeRunnersToRunMenu

addCodeRunnersToRunMenu(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, consoleTracker: IConsoleTracker, trans: TranslationBundle, sessionDialogs: ISessionContextDialogs | null): void

- Defined in packages/fileeditor-extension/src/commands.ts:1283
Add a File Editor code runner to the Run menu

Parameters
- menu: IMainMenu
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- consoleTracker: IConsoleTracker
- trans: TranslationBundle
- sessionDialogs: ISessionContextDialogs | null
Returns void

addCommands

addCommands(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, browserFactory: IFileBrowserFactory): void

- Defined in packages/fileeditor-extension/src/commands.ts:212
Wrapper function for adding the default File Editor commands

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- browserFactory: IFileBrowserFactory
Returns void

addConsoleCreatorToFileMenu

addConsoleCreatorToFileMenu(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1264
Add a File Editor console creator to the File menu

Parameters
- menu: IMainMenu
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
Returns void

addCopyCommand

addCopyCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:798
Add copy command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addCreateConsoleCommand

addCreateConsoleCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:506
Add the Create Console for Editor command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addCreateNewCommand

addCreateNewCommand(commands: CommandRegistry, browserFactory: IFileBrowserFactory, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:947
Add the New File command

Defaults to Text/.txt if file type data is not specified

Parameters
- commands: CommandRegistry
- browserFactory: IFileBrowserFactory
- trans: TranslationBundle
Returns void

addCreateNewCommandToPalette

addCreateNewCommandToPalette(palette: ICommandPalette, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1101
Add a Create New File command to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addCreateNewMarkdownCommand

addCreateNewMarkdownCommand(commands: CommandRegistry, browserFactory: IFileBrowserFactory, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:981
Add the New Markdown File command

Parameters
- commands: CommandRegistry
- browserFactory: IFileBrowserFactory
- trans: TranslationBundle
Returns void

addCreateNewMarkdownCommandToPalette

addCreateNewMarkdownCommandToPalette(palette: ICommandPalette, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1116
Add a Create New Markdown command to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addCreateNewMarkdownToLauncher

addCreateNewMarkdownToLauncher(launcher: ILauncher, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1029
Add Create New Markdown to the Launcher

Parameters
- launcher: ILauncher
- trans: TranslationBundle
Returns void

addCreateNewToLauncher

addCreateNewToLauncher(launcher: ILauncher, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1015
Add Create New Text File to the Launcher

Parameters
- launcher: ILauncher
- trans: TranslationBundle
Returns void

addCutCommand

addCutCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:756
Add cut command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addEditorViewerToViewMenu

addEditorViewerToViewMenu(menu: IMainMenu, tracker: WidgetTracker<IDocumentWidget<FileEditor>>): void

- Defined in packages/fileeditor-extension/src/commands.ts:1233
Add a File Editor editor viewer to the View Menu

Parameters
- menu: IMainMenu
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
Returns void

addKernelLanguageLauncherItems

addKernelLanguageLauncherItems(launcher: ILauncher, trans: TranslationBundle, availableKernelFileTypes: Iterable<IFileTypeData>): void

- Defined in packages/fileeditor-extension/src/commands.ts:1043
Add ___ File items to the Launcher for common file types associated with available kernels

Parameters
- launcher: ILauncher
- trans: TranslationBundle
- availableKernelFileTypes: Iterable<IFileTypeData>
Returns void

addKernelLanguageMenuItems

addKernelLanguageMenuItems(menu: IMainMenu, availableKernelFileTypes: Iterable<IFileTypeData>): void

- Defined in packages/fileeditor-extension/src/commands.ts:1199
Add Create New ___ File commands to the File menu for common file types associated with available kernels

Parameters
- menu: IMainMenu
- availableKernelFileTypes: Iterable<IFileTypeData>
Returns void

addKernelLanguagePaletteItems

addKernelLanguagePaletteItems(palette: ICommandPalette, trans: TranslationBundle, availableKernelFileTypes: Iterable<IFileTypeData>): void

- Defined in packages/fileeditor-extension/src/commands.ts:1148
Add New ___ File commands to the File Editor palette for common file types associated with available kernels

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
- availableKernelFileTypes: Iterable<IFileTypeData>
Returns void

addLauncherItems

addLauncherItems(launcher: ILauncher, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1003
Wrapper function for adding the default launcher items for File Editor

Parameters
- launcher: ILauncher
- trans: TranslationBundle
Returns void

addLineNumbersCommand

addLineNumbersCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:311
Add the Line Numbers command

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addMarkdownPreviewCommand

addMarkdownPreviewCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:647
Add markdown preview command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
Returns void

addMatchBracketsCommand

addMatchBracketsCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:404
Add the Match Brackets command

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addMenuItems

addMenuItems(menu: IMainMenu, commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, consoleTracker: IConsoleTracker | null, sessionDialogs: ISessionContextDialogs | null): void

- Defined in packages/fileeditor-extension/src/commands.ts:1166
Wrapper function for adding the default menu items for File Editor

Parameters
- menu: IMainMenu
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- consoleTracker: IConsoleTracker | null
- sessionDialogs: ISessionContextDialogs | null
Returns void

addPaletteItems

addPaletteItems(palette: ICommandPalette, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1061
Wrapper function for adding the default items to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addPasteCommand

addPasteCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:839
Add paste command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addRedoCommand

addRedoCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:718
Add redo command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addReplaceSelectionCommand

addReplaceSelectionCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:483
Add the replace selection for text editor command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addRunAllCodeCommand

addRunAllCodeCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:602
Add the Run All Code command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addRunCodeCommand

addRunCodeCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:531
Add the Run Code command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addSelectAllCommand

addSelectAllCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:873
Add select all command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addUndoCommand

addUndoCommand(commands: CommandRegistry, tracker: WidgetTracker<IDocumentWidget<FileEditor>>, trans: TranslationBundle, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:680
Add undo command

Parameters
- commands: CommandRegistry
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
- trans: TranslationBundle
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

addUndoRedoToEditMenu

addUndoRedoToEditMenu(menu: IMainMenu, tracker: WidgetTracker<IDocumentWidget<FileEditor>>): void

- Defined in packages/fileeditor-extension/src/commands.ts:1215
Add File Editor undo and redo widgets to the Edit menu

Parameters
- menu: IMainMenu
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
Returns void

addWordWrapCommand

addWordWrapCommand(commands: CommandRegistry, settingRegistry: ISettingRegistry, trans: TranslationBundle, id: string, isEnabled: () => boolean): void

- Defined in packages/fileeditor-extension/src/commands.ts:336
Add the Word Wrap command

Parameters
- commands: CommandRegistry
- settingRegistry: ISettingRegistry
- trans: TranslationBundle
- id: string
- isEnabled: () => boolean
  - - (): boolean
    - Returns boolean
Returns void

updateSettings

updateSettings(settings: ISettings, commands: CommandRegistry): void

- Defined in packages/fileeditor-extension/src/commands.ts:176
Update the setting values.

Parameters
- settings: ISettings
- commands: CommandRegistry
Returns void

updateTracker

updateTracker(tracker: WidgetTracker<IDocumentWidget<FileEditor>>): void

- Defined in packages/fileeditor-extension/src/commands.ts:192
Update the settings of the current tracker instances.

Parameters
- tracker: WidgetTracker<IDocumentWidget<FileEditor>>
Returns void

updateWidget

updateWidget(widget: FileEditor): void

- Defined in packages/fileeditor-extension/src/commands.ts:204
Update the settings of a widget. Skip global settings for transient editor specific configs.

Parameters
- widget: FileEditor
Returns void

Generated using TypeDoc