📝 Make Gutter class extended

Gutter is returned from a public method `TextEditor::addGutter`
This commit is contained in:
Maxim Sokolov
2015-08-26 11:44:31 +03:00
parent fac979f71d
commit fbb3bc4232

View File

@@ -1,19 +1,14 @@
{Emitter} = require 'event-kit'
# Public: This class represents a gutter within a TextEditor.
DefaultPriority = -100
# Extended: Represents a gutter within a {TextEditor}.
#
# ### Gutter Creation
#
# See {TextEditor::addGutter} for usage.
module.exports =
class Gutter
# * `gutterContainer` The {GutterContainer} object to which this gutter belongs.
# * `options` An {Object} with the following fields:
# * `name` (required) A unique {String} to identify this gutter.
# * `priority` (optional) A {Number} that determines stacking order between
# gutters. Lower priority items are forced closer to the edges of the
# window. (default: -100)
# * `visible` (optional) {Boolean} specifying whether the gutter is visible
# initially after being created. (default: true)
constructor: (gutterContainer, options) ->
@gutterContainer = gutterContainer
@name = options?.name