More updates

This commit is contained in:
Garen Torikian 2012-04-25 13:02:43 -07:00
commit c31834c678
5 changed files with 27 additions and 32 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

View file

@ -21,19 +21,16 @@ div#well
li li
div.menu-item div.menu-item
a(class="menuLink namespace", href="editor.html") Editor a(class="menuLink namespace", href="editor.html") Editor
li //- probably not needing doc a(class="menuLink namespace", href="multi_select.html") MultiSelect
div.menu-item
a(class="menuLink namespace", href="multi_select.html") MultiSelect //- not actually doc'ed yet a(class="menuLink namespace", href="placeholder.html") PlaceHolder
li
div.menu-item
a(class="menuLink namespace", href="placeholder.html") PlaceHolder
li li
div.menu-item div.menu-item
a(class="menuLink namespace", href="range.html") Range a(class="menuLink namespace", href="range.html") Range
//- not actually doc'ed yet //- not actually doc'ed yet a(class="menuLink namespace", href="renderloop.html") RenderLoop
li
div.menu-item
a(class="menuLink namespace", href="renderloop.html") RenderLoop
li li
div.menu-item div.menu-item
a(class="menuLink namespace", href="scrollbar.html") Scrollbar a(class="menuLink namespace", href="scrollbar.html") Scrollbar

View file

@ -71,7 +71,7 @@ var EditSession = require("./edit_session").EditSession;
// automatically sorted list of ranges // automatically sorted list of ranges
this.rangeList = null; this.rangeList = null;
/** /** extension
* Selection.addRange(range, $blockChangeEvents) * Selection.addRange(range, $blockChangeEvents)
* - range (Range): The new range to add * - range (Range): The new range to add
* - $blockChangeEvents (Boolean): Whether or not to block changing events * - $blockChangeEvents (Boolean): Whether or not to block changing events
@ -120,7 +120,7 @@ var EditSession = require("./edit_session").EditSession;
range && this.fromOrientedRange(range); range && this.fromOrientedRange(range);
}; };
/** /** extension
* Selection.substractPoint(pos) -> Range * Selection.substractPoint(pos) -> Range
* - pos (Range): The position to remove, as a `{row, column}` object * - pos (Range): The position to remove, as a `{row, column}` object
* *
@ -134,7 +134,7 @@ var EditSession = require("./edit_session").EditSession;
} }
}; };
/** /** extension
* Selection.mergeOverlappingRanges() * Selection.mergeOverlappingRanges()
* *
* Merges overlapping ranges ensuring consistency after changes * Merges overlapping ranges ensuring consistency after changes
@ -211,7 +211,7 @@ var EditSession = require("./edit_session").EditSession;
} }
}; };
/** /** extension
* Selection.rectangularRangeBlock(screenCursor, screenAnchor, includeEmptyLines) -> Range * Selection.rectangularRangeBlock(screenCursor, screenAnchor, includeEmptyLines) -> Range
* - screenCursor (Cursor): The cursor to use * - screenCursor (Cursor): The cursor to use
* - screenAnchor (Anchor): The anchor to use * - screenAnchor (Anchor): The anchor to use
@ -288,17 +288,18 @@ var EditSession = require("./edit_session").EditSession;
// extend Editor // extend Editor
var Editor = require("./editor").Editor; var Editor = require("./editor").Editor;
(function() { (function() {
/**
/** extension
* Editor.updateSelectionMarkers() * Editor.updateSelectionMarkers()
* *
* updates cursor and marker layers * Updates the cursor and marker layers.
**/ **/
this.updateSelectionMarkers = function() { this.updateSelectionMarkers = function() {
this.renderer.updateCursor(); this.renderer.updateCursor();
this.renderer.updateBackMarkers(); this.renderer.updateBackMarkers();
}; };
/** /** extension
* Editor.addSelectionMarker(orientedRange) -> Range * Editor.addSelectionMarker(orientedRange) -> Range
* - orientedRange (Range): A range containing a cursor * - orientedRange (Range): A range containing a cursor
* *
@ -316,7 +317,7 @@ var Editor = require("./editor").Editor;
return orientedRange; return orientedRange;
}; };
/** /** extension
* Editor.removeSelectionMarker(range) * Editor.removeSelectionMarker(range)
* - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]]. * - range (Range): The selection range added with [[Editor.addSelectionMarker `addSelectionMarker()`]].
* *
@ -402,7 +403,7 @@ var Editor = require("./editor").Editor;
e.preventDefault(); e.preventDefault();
}; };
/** /** extension
* Editor.forEachSelection(cmd, args) * Editor.forEachSelection(cmd, args)
* - cmd (String): The command to execute * - cmd (String): The command to execute
* - args (String): Any arguments for the command * - args (String): Any arguments for the command
@ -439,10 +440,10 @@ var Editor = require("./editor").Editor;
this.onSelectionChange(); this.onSelectionChange();
}; };
/** /** extension
* Editor.exitMultiSelectMode() * Editor.exitMultiSelectMode()
* *
* removes all selections except the last added one. * Removes all the selections except the last added one.
**/ **/
this.exitMultiSelectMode = function() { this.exitMultiSelectMode = function() {
if (this.inVirtualSelectionMode) if (this.inVirtualSelectionMode)
@ -466,7 +467,7 @@ var Editor = require("./editor").Editor;
return text; return text;
}; };
/** /** extension
* Editor.findAll(needle, dir, additive) -> Number * Editor.findAll(needle, dir, additive) -> Number
* - needle (String): The text to find * - needle (String): The text to find
* - options (Object): Any of the additional [[Search search options]] * - options (Object): Any of the additional [[Search search options]]
@ -500,7 +501,7 @@ var Editor = require("./editor").Editor;
}; };
// commands // commands
/** /** extension
* Editor.selectMoreLines(dir, skip) * Editor.selectMoreLines(dir, skip)
* - dir (Number): The direction of lines to select: -1 for up, 1 for down * - dir (Number): The direction of lines to select: -1 for up, 1 for down
* - skip (Boolean): If `true`, removes the active selection range * - skip (Boolean): If `true`, removes the active selection range
@ -545,7 +546,7 @@ var Editor = require("./editor").Editor;
this.selection.substractPoint(toRemove); this.selection.substractPoint(toRemove);
}; };
/** /** extension
* Editor.transposeSelections(dir) * Editor.transposeSelections(dir)
* - dir (Number): The direction to rotate selections * - dir (Number): The direction to rotate selections
* *
@ -589,7 +590,7 @@ var Editor = require("./editor").Editor;
} }
} }
/** /** extension
* Editor.selectMore(dir, skip) * Editor.selectMore(dir, skip)
* - dir (Number): The direction of lines to select: -1 for up, 1 for down * - dir (Number): The direction of lines to select: -1 for up, 1 for down
* - skip (Boolean): If `true`, removes the active selection range * - skip (Boolean): If `true`, removes the active selection range
@ -661,12 +662,9 @@ exports.onSessionChange = function(e) {
} }
}; };
/** // MultiSelect(editor)
* MultiSelect(editor) // adds multiple selection support to the editor
* // (note: should be called only once for each editor instance)
* adds multiple selection support to the editor
* (note: should be called only once for each editor instance)
**/
function MultiSelect(editor) { function MultiSelect(editor) {
editor.$onAddRange = editor.$onAddRange.bind(editor); editor.$onAddRange = editor.$onAddRange.bind(editor);
editor.$onRemoveRange = editor.$onRemoveRange.bind(editor); editor.$onRemoveRange = editor.$onRemoveRange.bind(editor);

View file

@ -567,7 +567,7 @@ var Range = function(startRow, startColumn, endRow, endColumn) {
}).call(Range.prototype); }).call(Range.prototype);
/** /**
* Range#fromPoints(start, end) -> Range * Range.fromPoints(start, end) -> Range
* - start (Range): A starting point to use * - start (Range): A starting point to use
* - end (Range): An ending point to use * - end (Range): An ending point to use
* *