Represents the state of the user interface for the entire window.
An instance of this class is available via the atom.workspace
global.
Interact with this object to open files, be notified of current and future editors, and manipulate panes. To add panels, use Workspace::addTopPanel and friends.
Invoke the given callback with all current and future text editors in the workspace.
Argument | Description |
---|---|
|
Function to be called with current and future text editors. |
|
An TextEditor that is present in ::getTextEditors at the time of subscription or that is added at some later time. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback with all current and future panes items in the workspace.
Argument | Description |
---|---|
|
Function to be called with current and future pane items. |
|
An item that is present in ::getPaneItems at the time of subscription or that is added at some later time. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when the active pane item changes.
Argument | Description |
---|---|
|
Function to be called when the active pane item changes. |
|
The active pane item. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback with the current active pane item and with all future active pane items in the workspace.
Argument | Description |
---|---|
|
Function to be called when the active pane item changes. |
|
The current active pane item. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback whenever an item is opened. Unlike ::onDidAddPaneItem, observers will be notified for items that are already present in the workspace when they are reopened.
Argument | Description |
---|---|
|
Function to be called whenever an item is opened. |
|
Object with the following keys: |
|
String representing the opened URI. Could be |
|
The opened item. |
|
The pane in which the item was opened. |
|
The index of the opened item on its pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a pane is added to the workspace.
Argument | Description |
---|---|
|
Function to be called panes are added. |
|
Object with the following keys: |
|
The added pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a pane is destroyed in the workspace.
Argument | Description |
---|---|
|
Function to be called panes are destroyed. |
|
Object with the following keys: |
|
The destroyed pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback with all current and future panes in the workspace.
Argument | Description |
---|---|
|
Function to be called with current and future panes. |
|
A Pane that is present in ::getPanes at the time of subscription or that is added at some later time. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when the active pane changes.
Argument | Description |
---|---|
|
Function to be called when the active pane changes. |
|
A Pane that is the current return value of ::getActivePane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback with the current active pane and when the active pane changes.
Argument | Description |
---|---|
|
Function to be called with the current and future active# panes. |
|
A Pane that is the current return value of ::getActivePane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a pane item is added to the workspace.
Argument | Description |
---|---|
|
Function to be called when pane items are added. |
|
Object with the following keys: |
|
The added pane item. |
|
Pane containing the added item. |
|
Number indicating the index of the added item in its pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a pane item is about to be destroyed, before the user is prompted to save it.
Argument | Description |
---|---|
|
Function to be called before pane items are destroyed. |
|
Object with the following keys: |
|
The item to be destroyed. |
|
Pane containing the item to be destroyed. |
|
Number indicating the index of the item to be destroyed in its pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a pane item is destroyed.
Argument | Description |
---|---|
|
Function to be called when pane items are destroyed. |
|
Object with the following keys: |
|
The destroyed item. |
|
Pane containing the destroyed item. |
|
Number indicating the index of the destroyed item in its pane. |
Return values |
---|
Returns a Disposable on which |
Invoke the given callback when a text editor is added to the workspace.
Argument | Description |
---|---|
|
Function to be called panes are added. |
|
Object with the following keys: |
|
TextEditor that was added. |
|
Pane containing the added text editor. |
|
Number indicating the index of the added text editor in its pane. |
Return values |
---|
Returns a Disposable on which |
Opens the given URI in Atom asynchronously. If the URI is already open, the existing item for that URI will be activated. If no URI is given, or no registered opener can open the URI, a new empty TextEditor will be created.
Argument | Description |
---|---|
|
optional
A String containing a URI. |
|
optional |
|
A Number indicating which row to move the cursor to initially. Defaults to |
|
A Number indicating which column to move the cursor to initially. Defaults to |
|
Either ‘left’ or ‘right’. If ‘left’, the item will be opened in leftmost pane of the current active pane’s row. If ‘right’, the item will be opened in the rightmost pane of the current active pane’s row. |
|
A Boolean indicating whether to call Pane::activate on containing pane. Defaults to |
|
A Boolean. If |
Return values |
---|
Returns a promise that resolves to the TextEditor for the file URI. |
Asynchronously reopens the last-closed item’s URI if it hasn’t already been reopened.
Return values |
---|
Returns a promise that is resolved when the item is opened |
Register an opener for a uri.
An TextEditor will be used if no openers return a value.
Argument | Description |
---|---|
|
A Function to be called when a path is being opened. |
Return values |
---|
Returns a Disposable on which |
Get the active item if it is an TextEditor.
Return values |
---|
Returns an TextEditor or `` if the current active item is not an TextEditor. |
This section only has Extended methods.
Make the next pane active.
Make the previous pane active.
Get an Array of all the panel items at the bottom of the editor window.
Adds a panel item to the bottom of the editor window.
Argument | Description |
---|---|
|
|
|
Your panel content. It can be DOM element, a jQuery element, or a model with a view registered via ViewRegistry::addViewProvider. We recommend the latter. See ViewRegistry::addViewProvider for more information. |
|
optional
Boolean false if you want the panel to initially be hidden (default: true) |
|
optional
Number Determines stacking order. Lower priority items are forced closer to the edges of the window. (default: 100) |
Return values |
---|
Returns a Panel |
Get an Array of all the panel items to the left of the editor window.
Adds a panel item to the left of the editor window.
Argument | Description |
---|---|
|
|
|
Your panel content. It can be DOM element, a jQuery element, or a model with a view registered via ViewRegistry::addViewProvider. We recommend the latter. See ViewRegistry::addViewProvider for more information. |
|
optional
Boolean false if you want the panel to initially be hidden (default: true) |
|
optional
Number Determines stacking order. Lower priority items are forced closer to the edges of the window. (default: 100) |
Return values |
---|
Returns a Panel |
Get an Array of all the panel items to the right of the editor window.
Adds a panel item to the right of the editor window.
Argument | Description |
---|---|
|
|
|
Your panel content. It can be DOM element, a jQuery element, or a model with a view registered via ViewRegistry::addViewProvider. We recommend the latter. See ViewRegistry::addViewProvider for more information. |
|
optional
Boolean false if you want the panel to initially be hidden (default: true) |
|
optional
Number Determines stacking order. Lower priority items are forced closer to the edges of the window. (default: 100) |
Return values |
---|
Returns a Panel |
Get an Array of all the panel items at the top of the editor window.
Adds a panel item to the top of the editor window above the tabs.
Argument | Description |
---|---|
|
|
|
Your panel content. It can be DOM element, a jQuery element, or a model with a view registered via ViewRegistry::addViewProvider. We recommend the latter. See ViewRegistry::addViewProvider for more information. |
|
optional
Boolean false if you want the panel to initially be hidden (default: true) |
|
optional
Number Determines stacking order. Lower priority items are forced closer to the edges of the window. (default: 100) |
Return values |
---|
Returns a Panel |
Get an Array of all the modal panel items
Adds a panel item as a modal dialog.
Argument | Description |
---|---|
|
|
|
Your panel content. It can be DOM element, a jQuery element, or a model with a view registered via ViewRegistry::addViewProvider. We recommend the latter. See ViewRegistry::addViewProvider for more information. |
|
optional
Boolean false if you want the panel to initially be hidden (default: true) |
|
optional
Number Determines stacking order. Lower priority items are forced closer to the edges of the window. (default: 100) |
Return values |
---|
Returns a Panel |
Argument | Description |
---|---|
|
Item the panel contains |
Return values |
---|
Returns the Panel associated with the given item. |
Returns
|
Performs a search across all the files in the workspace.
Argument | Description |
---|---|
|
RegExp to search with. |
|
optional
Object (default: {}) |
|
An Array of glob patterns to search within |
|
optional |
|
Function callback on each file found |
Return values |
---|
Returns a |
Performs a replace across all the specified files in the project.
Argument | Description |
---|---|
|
A RegExp to search with. |
|
Text to replace all matches of regex with |
|
List of file path strings to run the replace on. |
|
A Function callback on each file with replacements: |
|
Object with keys |
Return values |
---|
Returns a |