Dock extended
A container at the edges of the editor window capable of holding items. You should not create a Dock directly. Instead, access one of the three docks of the workspace via Workspace::getLeftDock, Workspace::getRightDock, and Workspace::getBottomDock or add an item to a dock via Workspace::open.
Methods
::activate()
Show the dock and focus its active Pane.
::show()
Show the dock without focusing it.
::hide()
Hide the dock and activate the WorkspaceCenter if the dock was was previously focused.
::toggle()
Toggle the dock's visibility without changing the Workspace's active pane container.
Event Subscription
::onDidChangeVisible(callback)
Invoke the given callback when the visibility of the dock changes.
| Argument | Description |
|---|---|
callback(visible) |
Function to be called when the visibility changes. |
visible |
Boolean Is the dock now visible? |
| Return values |
|---|
Returns a Disposable on which |
::observeVisible(callback)
Invoke the given callback with the current and all future visibilities of the dock.
| Argument | Description |
|---|---|
callback(visible) |
Function to be called when the visibility changes. |
visible |
Boolean Is the dock now visible? |
| Return values |
|---|
Returns a Disposable on which |
::observePaneItems(callback)
Invoke the given callback with all current and future panes items in the dock.
| Argument | Description |
|---|---|
callback(item) |
Function to be called with current and future pane items. |
item |
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 |
::onDidChangeActivePaneItem(callback)
Invoke the given callback when the active pane item changes.
Because observers are invoked synchronously, it's important not to perform any expensive operations via this method. Consider ::onDidStopChangingActivePaneItem to delay operations until after changes stop occurring.
| Argument | Description |
|---|---|
callback(item) |
Function to be called when the active pane item changes. |
item |
The active pane item. |
| Return values |
|---|
Returns a Disposable on which |
::onDidStopChangingActivePaneItem(callback)
Invoke the given callback when the active pane item stops changing.
Observers are called asynchronously 100ms after the last active pane item change. Handling changes here rather than in the synchronous ::onDidChangeActivePaneItem prevents unneeded work if the user is quickly changing or closing tabs and ensures critical UI feedback, like changing the highlighted tab, gets priority over work that can be done asynchronously.
| Argument | Description |
|---|---|
callback(item) |
Function to be called when the active pane item stopts changing. |
item |
The active pane item. |
| Return values |
|---|
Returns a Disposable on which |
::observeActivePaneItem(callback)
Invoke the given callback with the current active pane item and with all future active pane items in the dock.
| Argument | Description |
|---|---|
callback(item) |
Function to be called when the active pane item changes. |
item |
The current active pane item. |
| Return values |
|---|
Returns a Disposable on which |
::onDidAddPane(callback)
Invoke the given callback when a pane is added to the dock.
| Argument | Description |
|---|---|
callback(event) |
Function to be called panes are added. |
event |
Object with the following keys: |
.pane |
The added pane. |
| Return values |
|---|
Returns a Disposable on which |
::onWillDestroyPane(callback)
Invoke the given callback before a pane is destroyed in the dock.
| Argument | Description |
|---|---|
callback(event) |
Function to be called before panes are destroyed. |
event |
Object with the following keys: |
.pane |
The pane to be destroyed. |
| Return values |
|---|
Returns a Disposable on which |
::onDidDestroyPane(callback)
Invoke the given callback when a pane is destroyed in the dock.
| Argument | Description |
|---|---|
callback(event) |
Function to be called panes are destroyed. |
event |
Object with the following keys: |
.pane |
The destroyed pane. |
| Return values |
|---|
Returns a Disposable on which |
::observePanes(callback)
Invoke the given callback with all current and future panes in the dock.
| Argument | Description |
|---|---|
callback(pane) |
Function to be called with current and future panes. |
pane |
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 |
::onDidChangeActivePane(callback)
Invoke the given callback when the active pane changes.
| Argument | Description |
|---|---|
callback(pane) |
Function to be called when the active pane changes. |
pane |
A Pane that is the current return value of ::getActivePane. |
| Return values |
|---|
Returns a Disposable on which |
::observeActivePane(callback)
Invoke the given callback with the current active pane and when the active pane changes.
| Argument | Description |
|---|---|
callback(pane) |
Function to be called with the current and future active# panes. |
pane |
A Pane that is the current return value of ::getActivePane. |
| Return values |
|---|
Returns a Disposable on which |
::onDidAddPaneItem(callback)
Invoke the given callback when a pane item is added to the dock.
| Argument | Description |
|---|---|
callback(event) |
Function to be called when pane items are added. |
event |
Object with the following keys: |
.item |
The added pane item. |
.pane |
Pane containing the added item. |
.index |
Number indicating the index of the added item in its pane. |
| Return values |
|---|
Returns a Disposable on which |
::onWillDestroyPaneItem(callback)
Invoke the given callback when a pane item is about to be destroyed, before the user is prompted to save it.
| Argument | Description |
|---|---|
callback(event) |
Function to be called before pane items are destroyed. |
event |
Object with the following keys: |
.item |
The item to be destroyed. |
.pane |
Pane containing the item to be destroyed. |
.index |
Number indicating the index of the item to be destroyed in its pane. |
| Return values |
|---|
Returns a Disposable on which |
::onDidDestroyPaneItem(callback)
Invoke the given callback when a pane item is destroyed.
| Argument | Description |
|---|---|
callback(event) |
Function to be called when pane items are destroyed. |
event |
Object with the following keys: |
.item |
The destroyed item. |
.pane |
Pane containing the destroyed item. |
.index |
Number indicating the index of the destroyed item in its pane. |
| Return values |
|---|
Returns a Disposable on which |
Pane Items
Panes
::activateNextPane()
Make the next pane active.
::activatePreviousPane()
Make the previous pane active.