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:383
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:240
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:1018
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:330
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:962
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:1208
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:186
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:1189
Add a File Editor console creator to the File menu

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

addContextMenuItems

addContextMenuItems(app: JupyterFrontEnd): void

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

Parameters
- app: JupyterFrontEnd
Returns void

addCopyCommand

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

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

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

addCopyCommandToContextMenu

addCopyCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1316
Add a Copy item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addCreateConsoleCommand

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

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

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

addCreateConsoleToContextMenu

addCreateConsoleToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1263
Add a Create Console item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addCreateNewCommand

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

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

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

addCreateNewCommandToPalette

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

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

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addCreateNewFileToFileMenu

addCreateNewFileToFileMenu(menu: IMainMenu): void

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

Parameters
- menu: IMainMenu
Returns void

addCreateNewMarkdownCommand

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

- Defined in packages/fileeditor-extension/src/commands.ts:884
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:1003
Add a Create New Markdown command to the File Editor palette

Parameters
- palette: ICommandPalette
- trans: TranslationBundle
Returns void

addCreateNewMarkdownFileToFileMenu

addCreateNewMarkdownFileToFileMenu(menu: IMainMenu): void

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

Parameters
- menu: IMainMenu
Returns void

addCreateNewMarkdownToLauncher

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

- Defined in packages/fileeditor-extension/src/commands.ts:932
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:918
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:677
Add cut command

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

addCutCommandToContextMenu

addCutCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1305
Add a Cut item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addEditingCommandsToSettingsMenu

addEditingCommandsToSettingsMenu(menu: IMainMenu, commands: CommandRegistry, trans: TranslationBundle): void

- Defined in packages/fileeditor-extension/src/commands.ts:1078
Add File Editor editing commands to the Settings menu, including: Indent with Tab, Tab Spaces, Change Font Size, and auto closing brackets

Parameters
- menu: IMainMenu
- commands: CommandRegistry
- trans: TranslationBundle
Returns void

addEditorViewerToViewMenu

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

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

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

addLauncherItems

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

- Defined in packages/fileeditor-extension/src/commands.ts:906
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:275
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:569
Add markdown preview command

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

addMarkdownPreviewToContextMenu

addMarkdownPreviewToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1273
Add a Markdown Preview item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addMatchBracketsCommand

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

- Defined in packages/fileeditor-extension/src/commands.ts:358
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:1035
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:946
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:760
Add paste command

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

addPasteCommandToContextMenu

addPasteCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1327
Add a Paste item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addRedoCommand

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

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

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

addRedoCommandToContextMenu

addRedoCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1294
Add a Redo item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addReplaceSelectionCommand

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

- Defined in packages/fileeditor-extension/src/commands.ts:406
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:524
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:453
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:794
Add select all command

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

addSelectAllCommandToContextMenu

addSelectAllCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1338
Add a Select All item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addUndoCommand

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

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

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

addUndoCommandToContextMenu

addUndoCommandToContextMenu(app: JupyterFrontEnd): void

- Defined in packages/fileeditor-extension/src/commands.ts:1283
Add a Undo item to the File Editor context menu

Parameters
- app: JupyterFrontEnd
Returns void

addUndoRedoToEditMenu

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

- Defined in packages/fileeditor-extension/src/commands.ts:1139
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:300
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:145
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:161
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:173
Update the settings of a widget. Skip global settings for transient editor specific configs.

Parameters
- widget: FileEditor
Returns void

Generated using TypeDoc