github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-02-10 06:35:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate Dock::getActiveTextEditor()

Browse Source
This commit is contained in:
Jason Rudolph
2017-06-01 15:24:50 -04:00
parent e569f8fc4d
commit f8ebd71200
2 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/dock.js
View File

@@ -4,6 +4,7 @@ const _ = require('underscore-plus')
const {CompositeDisposable} = require('event-kit')
const PaneContainer = require('./pane-container')
const TextEditor = require('./text-editor')
const Grim = require('grim')
const MINIMUM_SIZE = 100
const DEFAULT_INITIAL_SIZE = 300
@@ -590,11 +591,13 @@ module.exports = class Dock {
return this.paneContainer.getTextEditors()
}
// Essential: Get the active item if it is a {TextEditor}.
// Deprecated: Get the active item if it is a {TextEditor}.
//
// Returns a {TextEditor} or `undefined` if the current active item is not a
// {TextEditor}.
getActiveTextEditor () {
Grim.deprecate('Text editors are not allowed in docks. Use atom.workspace.getActiveTextEditor() instead.')
const activeItem = this.getActivePaneItem()
if (activeItem instanceof TextEditor) { return activeItem }
}