This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5191 from adobe/pflynn/find-tickmarks
Show scroll track tickmarks for Find results
- Loading branch information
Showing
6 changed files
with
301 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
/* | ||
* Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved. | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a | ||
* copy of this software and associated documentation files (the "Software"), | ||
* to deal in the Software without restriction, including without limitation | ||
* the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
* and/or sell copies of the Software, and to permit persons to whom the | ||
* Software is furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
* DEALINGS IN THE SOFTWARE. | ||
* | ||
*/ | ||
|
||
/*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */ | ||
/*global define, $, brackets, window */ | ||
|
||
|
||
/** | ||
* Manages tickmarks shown along the scrollbar track. | ||
* NOT yet intended for use by anyone other than the FindReplace module. | ||
* It is assumed that markers are always clear()ed when switching editors. | ||
*/ | ||
define(function (require, exports, module) { | ||
"use strict"; | ||
|
||
var Editor = require("editor/Editor"), | ||
EditorManager = require("editor/EditorManager"), | ||
Async = require("utils/Async"); | ||
|
||
|
||
/** @const @type {number} Height (and width) or scrollbar up/down arrow button on Win */ | ||
var WIN_ARROW_HT = 17; | ||
|
||
/** @type {?Editor} Editor the markers are currently shown for, or null if not shown */ | ||
var editor; | ||
|
||
/** @type {number} Top of scrollbar track area, relative to top of scrollbar */ | ||
var trackOffset; | ||
|
||
/** @type {number} Height of scrollbar track area */ | ||
var trackHt; | ||
|
||
/** @type {!Array.<{line: number, ch: number}>} Text positions of markers */ | ||
var marks = []; | ||
|
||
|
||
/** Measure scrollbar track */ | ||
function _calcScaling() { | ||
var rootElem = editor.getRootElement(); | ||
var $sb = $(".CodeMirror-vscrollbar", rootElem); | ||
|
||
trackHt = $sb[0].offsetHeight; | ||
|
||
if (trackHt > 0) { | ||
// Scrollbar visible: determine offset of track from top of scrollbar | ||
if (brackets.platform === "win") { | ||
trackOffset = WIN_ARROW_HT; // Up arrow pushes down track | ||
} else { | ||
trackOffset = 0; // No arrows | ||
} | ||
|
||
} else { | ||
// No scrollbar: use the height of the entire code content | ||
trackHt = $(".CodeMirror-sizer", rootElem)[0].offsetHeight; | ||
trackOffset = 0; | ||
} | ||
|
||
trackHt -= trackOffset * 2; | ||
} | ||
|
||
/** Add one tickmark to the DOM */ | ||
function _renderMark(pos) { | ||
var top = Math.round(pos.line / editor.lineCount() * trackHt) + trackOffset; | ||
top--; // subtract ~1/2 the ht of a tickmark to center it on ideal pos | ||
|
||
var $mark = $("<div class='tickmark' style='top:" + top + "px'></div>"); | ||
|
||
$(".tickmark-track", editor.getRootElement()).append($mark); | ||
} | ||
|
||
|
||
/** | ||
* Clear any markers in the editor's tickmark track, but leave it visible. Safe to call when | ||
* tickmark track is not visible also. | ||
*/ | ||
function clear() { | ||
if (editor) { | ||
$(".tickmark-track", editor.getRootElement()).empty(); | ||
marks = []; | ||
} | ||
} | ||
|
||
/** Add or remove the tickmark track from the editor's UI */ | ||
function setVisible(curEditor, visible) { | ||
// short-circuit no-ops | ||
if ((visible && curEditor === editor) || (!visible && !editor)) { | ||
return; | ||
} | ||
|
||
if (visible) { | ||
console.assert(!editor); | ||
editor = curEditor; | ||
|
||
// Don't support inline editors yet - search inside them is pretty screwy anyway (#2110) | ||
if (editor.isTextSubset()) { | ||
return; | ||
} | ||
|
||
var rootElem = editor.getRootElement(); | ||
var $sb = $(".CodeMirror-vscrollbar", rootElem); | ||
var $overlay = $("<div class='tickmark-track'></div>"); | ||
$sb.parent().append($overlay); | ||
|
||
_calcScaling(); | ||
|
||
// Update tickmarks during window resize (whenever resizing has paused/stopped for > 1/3 sec) | ||
$(window).on("resize.ScrollTrackMarkers", Async.whenIdle(300, function () { | ||
if (marks.length) { | ||
_calcScaling(); | ||
$(".tickmark-track", editor.getRootElement()).empty(); | ||
marks.forEach(function (pos) { | ||
_renderMark(pos); | ||
}); | ||
} | ||
})); | ||
|
||
} else { | ||
console.assert(editor === curEditor); | ||
$(".tickmark-track", curEditor.getRootElement()).remove(); | ||
editor = null; | ||
marks = []; | ||
$(window).off("resize.ScrollTrackMarkers"); | ||
} | ||
} | ||
|
||
/** Add a tickmark to the editor's tickmark track, if it's visible */ | ||
function addTickmark(curEditor, pos) { | ||
console.assert(editor === curEditor); | ||
|
||
marks.push(pos); | ||
_renderMark(pos); | ||
} | ||
|
||
|
||
exports.clear = clear; | ||
exports.setVisible = setVisible; | ||
exports.addTickmark = addTickmark; | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.