Context Menu API, partial implementation #1012

tvoliter · 2012-06-07T20:57:50Z

Ready for review

mikechambers · 2012-06-07T21:07:51Z

Can you provide a simple example of how an extension would create and open a context-menu?

redmunds · 2012-06-07T22:34:31Z

src/command/Menus.js

+     * Represents a context menu that can open at a specific location in the UI. Call getMenu()
+     * to access the Menu object for adding MenuItems.
+     *
+     * Clients should nowtcreate this object directly and should instead use registerContextMenu()


typo: nowtcreate

tvoliter · 2012-06-07T23:43:22Z

Sure, here is a hello world demo you can paste into a main.js file to try it out as a plugin

/_jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */
/_global define, $, brackets, window */

/** Simple extension that adds a "File > Hello World" menu item */
define(function (require, exports, module) {
'use strict';

var CommandManager = brackets.getModule("command/CommandManager"),
    Menus          = brackets.getModule("command/Menus");


// Function to run when the menu item is clicked
function handleHelloWorld() {
    window.alert("Hello, world!");
}


// First, register a command - a UI-less object associating an id to a handler
var MY_COMMAND_ID = "helloworld.sayhello";
CommandManager.register("Hello World", MY_COMMAND_ID, handleHelloWorld);

// Register a new context menu
var cmenu = Menus.registerContextMenu("helloworld-context-menu");

// Get the menu object related to the context menu and add a MenuItem that will call your command
var menu = cmenu.getMenu();
menu.addMenuItem("mymenuid", MY_COMMAND_ID);

// Trigger the context meny by calling open(). Here we show it when right-clicking over the
// #projects div
$("#projects").mousedown(function (e) {
        if (e.which === 3) {
            cmenu.open(e.pageX, e.pageY);
        }
    });

});

-----Original Message-----
From: Mike Chambers [mailto:[email protected]]
Sent: Thursday, June 07, 2012 2:08 PM
To: Ty Voliter
Subject: Re: [brackets] Context Menu API (for review only) (#1012)

Can you provide a simple example of how an extension would create and open a context-menu?

Reply to this email directly or view it on GitHub:
#1012 (comment)

mikechambers · 2012-06-07T23:53:58Z

Could the x,y coords to open be optional, and if they are not passed in default to the correct position relative to the current position of the mouse?

Otherwise, there may be situations where the position of the menu should be different depending on the platform, that extension developers might not know about, or might not take into account.

Plus, it covers the primary use case and would make the api easier to use.

redmunds · 2012-06-08T00:03:57Z

@mikechambers On Windows, you can use the context-menu button to open a context-menu for the currently selected element (not at the mouse), so this is so both the keyboard and the mouse can be supported.

After that, Brackets will attempt to display the menu at the specified coordinates, but will adjust the menu position as necessary to fit it in the Brackets window.

mikechambers · 2012-06-08T00:05:42Z

@redmunds Sorry. What is the context-menu button?

tvoliter · 2012-06-08T00:13:40Z

Great suggestion!

-----Original Message-----
From: Mike Chambers [mailto:[email protected]]
Sent: Thursday, June 07, 2012 4:54 PM
To: Ty Voliter
Subject: Re: [brackets] Context Menu API (for review only) (#1012)

Could the x,y coords to open be optional, and if they are not passed in default to the correct position relative to the current position of the mouse?

Otherwise, there may be situations where the position of the menu should be different depending on the platform, that extension developers might not know about, or might not take into account.

Plus, it covers the primary use case and would make the api easier to use.

Reply to this email directly or view it on GitHub:
#1012 (comment)

mikechambers · 2012-06-08T00:22:30Z

@redmunds Thanks. I didn't realize that you were referring to the context menu keyboard button on some windows keyboards. (I didn't even know such a thing existed).

mikechambers · 2012-06-08T00:33:23Z

What happens if multiple extensions want to work with the context menu and / or add items to it? For example, imagine a context menu opened when text selected and the user right clicks it. How will multiple extensions be able to add items to a single context menu?

Also, will there be default items (copy, cut, paste) that will always be in the context menu?

tvoliter · 2012-06-08T00:38:10Z

These are great questions and this is what I am actually investigating next. Early thoughts were that Brackets would have a few built in context menus tied to specific click areas like the editor, working set, file tree, etc. Plugins could add to these and could be more context sensitive by disabling/enabling items based on some criteria when the beforeContextMenuOpen event is triggered. I am also exploring how event bubbling and context menus will interact to see how Brackets will handle a general context menu that shows when clicking over a large div and a very specific context menu that shows when clicking on some small portion of that div.

What are your expectations on how this should work?

-----Original Message-----
From: Mike Chambers [mailto:[email protected]]
Sent: Thursday, June 07, 2012 5:33 PM
To: Ty Voliter
Subject: Re: [brackets] Context Menu API (for review only) (#1012)

What happens if multiple extensions want to work with the context menu and / or add items to it? For example, imagine a context menu opened when text selected and the user right clicks it. How will multiple extensions be able to add items to a single context menu?

Also, will there be default items (copy, cut, paste) that will always be in the context menu?

Reply to this email directly or view it on GitHub:
#1012 (comment)

mikechambers · 2012-06-08T00:46:06Z

I would expect that my extension would add to an existing menu, and would not create a new one from scratch.

tvoliter · 2012-06-08T22:08:24Z

I did a bit of research and it seems it's not possible to query the current mouse position in browsers without an event. However, to make this API for friendly I changed it so it can take a MouseEvent or a specific location.

-----Original Message-----
From: Mike Chambers [mailto:[email protected]]
Sent: Thursday, June 07, 2012 4:54 PM
To: Ty Voliter
Subject: Re: [brackets] Context Menu API (for review only) (#1012)

Could the x,y coords to open be optional, and if they are not passed in default to the correct position relative to the current position of the mouse?

Otherwise, there may be situations where the position of the menu should be different depending on the platform, that extension developers might not know about, or might not take into account.

Plus, it covers the primary use case and would make the api easier to use.

Reply to this email directly or view it on GitHub:
#1012 (comment)

…to tvoliter/context-menus

…liter/context-menus * origin/tvoliter/context-menus: round all corners of context-menus round top corners of context menus share styles Now maintains the horizontal scroll position, as well. Changed scrollDelta to scrollDeltaY, and rounded the value out. Use :visible to skip the entire directory if it is not visible. Fix JSLint error Update About dialog sprint number Update CodeMirror SHA - Make 'Find in Files' result sections collapsible - Fix text spacing glitch with 'Find in Files' panel header Update SHA to reference latest CM merge Updated to work with merged CodeMirror for sprint 10 Now scrolls the document to the original position after adjusting the font size up or down. Conflicts: src/command/Menus.js

redmunds · 2012-06-13T16:10:25Z

src/command/Menus.js

+     *
+     * To make menu items be contextual to things like selection listen for the "beforeContextMenuOpen"
+     * to make changes to Command objects before the context menu is shown. MenuItems are views of
+     * Commands and control a MenuItem's name, enabled state, and checked stae.


typo: "stae"

Fixed. I also changed "MenuItems are views of Commands and control a MenuItem's ..." to "MenuItems are views of Commands which control a MenuItem's ..."

…liter/context-menus * origin/tvoliter/context-menus: no need to escape id when building a dom node. fix typos. fix comment fix alignment add extension to test context menus

* origin/master: (33 commits) code review comments Update comments Update CodeMirror SHA code review fixes Restore Shift-Tab to outdent behavior Re-implement performance suite filtering due to RequireJS changes in SpecRunner Revert .json file listing of test suites. Add ExtensionUtils to root require context added a comment explaining why we aren't using jquery deferreds for the done loading notification Fix #971 (Find in Files treats \n, \r, etc. as regular expressions) -- Escape backslash too (and simplify escaping regexp to use char class instead of |). createTestWindowAndRun now waits for brackets to be completely done loading (so extensions are loaded before tests run) added a 'ready' event to brackets that fires when brackets is completely done loading Rewrote unit tests for JavaScriptInlineEditor to get JSUtils from the require context that was used to load the extension. We only need to do this in unit tests where we rely on JSUtils to get the DocumentManager, etc. from the current window. Modified ExtensionLoader to allow for retrieving the require context that loaded an extension Refactor loadStyleSheet. Change error handling. provide way for unit tests to restore commands after a reset Fixed bug where triangle wasn't updating correctly by toggling "scroll" events on double click show Fix for double-click not working Removed unused comments Code review fixes. ...

tvoliter · 2012-06-13T18:16:34Z

src/styles/brackets_variables.less

@@ -50,3 +50,5 @@

 @z-index-brackets-sidebar-resizer: @z-index-brackets-ui + 2;
 @z-index-brackets-resizer-div: @z-index-brackets-sidebar-resizer + 1;
+
+@z-index-brackets-context-menu-base:    1000;


Should this be a relative offset as well (some reference + 1) instead of a constant?

This was intended to be the reference (or base) that all other context menu z-indexes are based off of. Currently, this is the only one. :)

Would be nice to unify this with the main menus, but currently these index values are hard-coded in bootstrap (even though they are using LESS).

…liter/context-menus * origin/tvoliter/context-menus: udpate comments add UL container for context menus

…to tvoliter/context-menus

…liter/context-menus * origin/tvoliter/context-menus: cleanup default context menus

* origin/master: Pre-filter function list in _findAllMatchingFunctions() Updated CodeMirror SHA Code review tweaks for JS inline editor. Added functionality to restore the font size to its original setting. Added 'Restore Font Size' Added semi-colons to the end of symbol entities to make them compatible with integers, and added the restore font menu item. Added VIEW_RESTORE_FONT_SIZE Conflicts: src/command/Menus.js

…ull instead of throwing

* origin/master: Updating CodeMirror SHA

Merging

tvoliter added 3 commits June 7, 2012 09:09

context menu prototype

5daac88

hack less to make context menus look right

24d03a8

Completing first draft of API

95aa501

redmunds reviewed Jun 7, 2012
View reviewed changes

api work

37bc9ff

tvoliter and others added 10 commits June 8, 2012 15:09

add missing @extends annotation

2037256

code review fixes for context menu API

7c431a9

share styles

1795a55

Merge remote-tracking branch 'origin/master' into tvoliter/context-menus

c994b93

Merge branch 'tvoliter/context-menus' of github.com:adobe/brackets in…

6d6f004

…to tvoliter/context-menus

round top corners of context menus

1f4dd84

round all corners of context-menus

a8fb498

working

9312bbc

prevent menus from stealing focus

ef70b24

redmunds reviewed Jun 13, 2012
View reviewed changes

redmunds and others added 4 commits June 13, 2012 10:58

no need to escape id when building a dom node. fix typos.

47d587f

added todo

795c1ef

Merge remote-tracking branch 'origin/tvoliter/context-menus' into tvo…

2ec6641

…liter/context-menus * origin/tvoliter/context-menus: no need to escape id when building a dom node. fix typos. fix comment fix alignment add extension to test context menus

tvoliter reviewed Jun 13, 2012
View reviewed changes

redmunds and others added 16 commits June 13, 2012 14:05

add UL container for context menus

ee4cfad

udpate comments

723183a

code review fixes

759390c

Merge remote-tracking branch 'origin/tvoliter/context-menus' into tvo…

fec168c

…liter/context-menus * origin/tvoliter/context-menus: udpate comments add UL container for context menus

review fixes

e1ca09f

cleanup default context menus

4ee0aa2

Merge branch 'tvoliter/context-menus' of github.com:adobe/brackets in…

cad981e

…to tvoliter/context-menus

use focused editor in ContextMenuTest

0948a6c

Merge remote-tracking branch 'origin/tvoliter/context-menus' into tvo…

11cc3d3

…liter/context-menus * origin/tvoliter/context-menus: cleanup default context menus

code review fixes

3b3df72

code review fixes

b26127a

keep only project context menu for now

1503b63

Updating CommandManager and Menu tests since duplicate id's returns n…

f65b33e

…ull instead of throwing

update comment

5a4d99e

Merge remote-tracking branch 'origin/master' into tvoliter/context-menus

ebb511c

* origin/master: Updating CodeMirror SHA

tvoliter added a commit that referenced this pull request Jun 14, 2012

Merge pull request #1012 from adobe/tvoliter/context-menus

ea3d26f

Merging

tvoliter merged commit ea3d26f into master Jun 14, 2012

core-ai-bot mentioned this pull request Aug 29, 2021

[CLOSED] Context Menu API, partial implementation brackets-archive/bracketsIssues#1006

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Context Menu API, partial implementation #1012

Context Menu API, partial implementation #1012

tvoliter commented Jun 7, 2012

mikechambers commented Jun 7, 2012

redmunds Jun 7, 2012

tvoliter commented Jun 7, 2012

mikechambers commented Jun 7, 2012

redmunds commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

mikechambers commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

redmunds Jun 13, 2012

redmunds Jun 13, 2012

tvoliter Jun 13, 2012

redmunds Jun 13, 2012

Context Menu API, partial implementation #1012

Context Menu API, partial implementation #1012

Conversation

tvoliter commented Jun 7, 2012

mikechambers commented Jun 7, 2012

redmunds Jun 7, 2012

Choose a reason for hiding this comment

tvoliter commented Jun 7, 2012

mikechambers commented Jun 7, 2012

redmunds commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

mikechambers commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

mikechambers commented Jun 8, 2012

tvoliter commented Jun 8, 2012

redmunds Jun 13, 2012

Choose a reason for hiding this comment

redmunds Jun 13, 2012

Choose a reason for hiding this comment

tvoliter Jun 13, 2012

Choose a reason for hiding this comment

redmunds Jun 13, 2012

Choose a reason for hiding this comment