This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
Toggle panels and no-Distraction mode #11732
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -217,7 +217,7 @@ | |
| "platform": "mac" | ||
| } | ||
| ], | ||
| "view.toggleSidebar": [ | ||
| { | ||
| "key" : "Ctrl-Alt-H" | ||
| }, | ||
|
|
||
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,155 @@ | ||
| /* | ||
| * 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 */ | ||
|
There was a problem hiding this comment. Please review if all of these params to jslint are valid for this file. |
||
| /*global define, brackets */ | ||
|
|
||
| define(function (require, exports, module) { | ||
| "use strict"; | ||
|
|
||
| var Menus = brackets.getModule("command/Menus"), | ||
| CommandManager = brackets.getModule("command/CommandManager"), | ||
| Commands = brackets.getModule("command/Commands"), | ||
| Strings = brackets.getModule("strings"), | ||
| PreferencesManager = brackets.getModule("preferences/PreferencesManager"), | ||
| ViewUtils = brackets.getModule("utils/ViewUtils"), | ||
| KeyBindingManager = brackets.getModule("command/KeyBindingManager"), | ||
| WorkspaceManager = brackets.getModule("view/WorkspaceManager"); | ||
|
|
||
| // Constants | ||
| var PREFS_PURE_CODE = "noDistractions", | ||
| CMD_TOGGLE_PURE_CODE = "view.togglePureCode", | ||
| CMD_TOGGLE_PANELS = "view.togglePanels"; | ||
|
|
||
| //key binding keys | ||
| var togglePureCodeKey = "Ctrl-Shift-2", | ||
| togglePureCodeKeyMac = "Cmd-Shift-2", | ||
| togglePanelsKey = "Ctrl-Shift-`", | ||
| togglePanelsKeyMac = "Cmd-Shift-`"; | ||
|
|
||
| //locals | ||
| var _previouslyOpenPanelIDs = [], | ||
| panelsToggled = false, | ||
| layoutUpdated = false; | ||
|
|
||
| /** | ||
| * @private | ||
| * | ||
| * Updates the command checked status based on the preference name given. | ||
| * | ||
| * @param {string} name Name of preference that has changed | ||
|
There was a problem hiding this comment. Should we update the documentation as I don't see any {string} parameter. |
||
| */ | ||
| function _updateCheckedState() { | ||
| CommandManager.get(CMD_TOGGLE_PURE_CODE).setChecked(PreferencesManager.get(PREFS_PURE_CODE)); | ||
|
There was a problem hiding this comment. A null check would be better here. |
||
| } | ||
|
|
||
| function _togglePureCode() { | ||
| PreferencesManager.set(PREFS_PURE_CODE, !PreferencesManager.get(PREFS_PURE_CODE)); | ||
| } | ||
|
|
||
| /** | ||
| * hide all open panels | ||
|
|
||
| */ | ||
| function _hidePanelsIfRequired() { | ||
| var panelIDs = WorkspaceManager.getAllPanelIDs(), i = 0; | ||
| _previouslyOpenPanelIDs = []; | ||
| for (i = 0; i < panelIDs.length; i++) { | ||
|
|
||
| if (WorkspaceManager.getPanelForID(panelIDs[i]).isVisible()) { | ||
|
There was a problem hiding this comment. It is better to have a There was a problem hiding this comment. As we just got the panel ID's from the above statement, this should never be null at this line. It would be better that a NULL access exception be raised here in that case, else will be hard to debug if things fails- which it should not 🔮 . There was a problem hiding this comment. We will never know whether we are given a null panel or an actual panel as that entirely depends on the API that is getting called. A check is surely of no harm here. |
||
| WorkspaceManager.getPanelForID(panelIDs[i]).hide(); | ||
| _previouslyOpenPanelIDs.push(panelIDs[i]); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * show all open panels that was previously hidden by _hidePanelsIfRequired() | ||
| */ | ||
| function _showPanelsIfRequired() { | ||
| var panelIDs = _previouslyOpenPanelIDs, i = 0; | ||
|
There was a problem hiding this comment. No need of an extra variable |
||
| for (i = 0; i < panelIDs.length; i++) { | ||
| if (WorkspaceManager.getPanelForID(panelIDs[i])) { | ||
|
There was a problem hiding this comment. Store the result from |
||
| WorkspaceManager.getPanelForID(panelIDs[i]).show(); | ||
| } | ||
| } | ||
| _previouslyOpenPanelIDs = []; | ||
| } | ||
|
|
||
| function _updateLayout() { | ||
| layoutUpdated = true; | ||
| panelsToggled = false; | ||
| } | ||
|
|
||
| /** | ||
| * We toggle panels in certain cases only : | ||
| * 1. if a panel is shown, toggle can hide it, and successive toggle can show the panel and repeat. | ||
| * 2. if a panel is hidden by toggle, and say the workspace changed making another panel visible by some operation; | ||
| * we reset toggle states so that toggle would hide the panel already present in the workspace. | ||
| * The already hidden panel should not be shown in the specific case for better UX. | ||
| */ | ||
| function _togglePanels() { | ||
| panelsToggled = !panelsToggled; | ||
| if (panelsToggled) { | ||
| _hidePanelsIfRequired(); | ||
| layoutUpdated = false; | ||
| panelsToggled = true; | ||
| } else if (!layoutUpdated) { | ||
| _showPanelsIfRequired(); | ||
| } | ||
| } | ||
|
|
||
| PreferencesManager.definePreference(PREFS_PURE_CODE, "boolean", false, { | ||
| description: Strings.DESCRIPTION_PURE_CODING_SURFACE | ||
| }); | ||
|
|
||
| PreferencesManager.on("change", PREFS_PURE_CODE, function () { | ||
|
There was a problem hiding this comment.
|
||
| if (PreferencesManager.get(PREFS_PURE_CODE)) { | ||
| ViewUtils.hideMainToolBar(); | ||
| CommandManager.execute(Commands.HIDE_SIDEBAR); | ||
| _hidePanelsIfRequired(); | ||
| } else { | ||
| ViewUtils.showMainToolBar(); | ||
| CommandManager.execute(Commands.SHOW_SIDEBAR); | ||
| _showPanelsIfRequired(); | ||
| } | ||
| _updateCheckedState(); | ||
| }); | ||
|
|
||
| WorkspaceManager.on("workspaceUpdateLayout", _updateLayout); | ||
|
|
||
| /** | ||
| * Register the Commands , add the Menu Items and key bindings | ||
| */ | ||
| function initializeCommands() { | ||
| CommandManager.register(Strings.CMD_TOGGLE_PURE_CODE, CMD_TOGGLE_PURE_CODE, _togglePureCode); | ||
| CommandManager.register(Strings.CMD_TOGGLE_PANELS, CMD_TOGGLE_PANELS, _togglePanels); | ||
|
|
||
| Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).addMenuItem(CMD_TOGGLE_PANELS, "", Menus.AFTER, Commands.VIEW_HIDE_SIDEBAR); | ||
| Menus.getMenu(Menus.AppMenuBar.VIEW_MENU).addMenuItem(CMD_TOGGLE_PURE_CODE, "", Menus.AFTER, CMD_TOGGLE_PANELS); | ||
|
|
||
| KeyBindingManager.addBinding(CMD_TOGGLE_PURE_CODE, [ {key: togglePureCodeKey}, {key: togglePureCodeKeyMac, platform: "mac"} ]); | ||
| KeyBindingManager.addBinding(CMD_TOGGLE_PANELS, [ {key: togglePanelsKey}, {key: togglePanelsKeyMac, platform: "mac"} ]); | ||
| } | ||
|
|
||
| initializeCommands(); | ||
|
|
||
| }); | ||
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
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
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change copyright from 2013 to 2015