Dynamically add menu mnemonics to all menus #2382

GKFX · 2014-03-01T13:46:30Z

Added and called Toolkit.setMenuMnemonics(JMenuItem...) and Toolkit.setMenuMnemonics(JMenuBar). These automatically set menu mnemonics based on the KDE, Windows, and Gnome human-interface guidelines, except on Mac, where as per Mac HIGs, it does nothing.
Really, there should be a Toolkit.setMenuMnemonics(JPopupMenu), but I couldn't make one, so I've called
Toolkit.setMenuMnemonics(firstItem, secondItem, thirdItem, ...) instead.
#51

Added Toolkit.setMenuMnemonics(JMenuItem...) and Toolkit.setMenuMnemonics(JMenuBar).

GKFX · 2014-03-01T13:47:07Z

Human Interface Guidelines

Mac

No mnemonics. (https://developer.apple.com/library/mac/documentation/Java/Conceptual/Java14Development/07-NativePlatformIntegration/NativePlatformIntegration.html)

Gnome

(https://developer.gnome.org/hig-book/3.10/hig-book.html#choosing-access-keys)

Assign access keys to the most frequently-used controls first. If it's not clear which controls will be the most frequently used, assign access keys from left to right, top to bottom (for Western locales).

Use the first letter of the label, or of one of its other words if it has more than one. If another letter provides a better association (e.g. "x" in Extra Large) however, consider using that letter instead.

If the first letter is not available, choose an easy to remember consonant from the label, for example, "p" in Replace.

If no such consonants are available, choose any available vowel from the label.
If duplication of access keys in a window is unavoidable, you should still refrain from duplicating the access keys for any of these buttons that appear in the same window: OK, Cancel, Close, Apply or Help.
Also, it is better not to assign access keys to "thin" letters (such as lowercase i or l), or letters with descenders (such as lowercase g or y) unless it is unavoidable. The underline does not show up very well on those characters in some fonts.

Microsoft

I couldn't find anything except Windows Mobile guidance, but it's sensible stuff anyway: (http://msdn.microsoft.com/en-us/library/bb158536.aspx)

Consider the following guidelines:

Choose the mnemonic in the following order of preference:

Use the first letter of the command name unless another letter provides a better mnemonic association.

If the first letter is already assigned to another command, use a letter that is as close as possible to the first letter of the command name.

Use a distinctive consonant in the command name.

Use a vowel in the command name.

Avoid duplication of mnemonic assignments or use of a letter that is difficult to see. Otherwise, choose the mnemonic in the following order of preference:

Letter that is next to a letter with a descender.

Letter with descender, such as p, g, q, or y.

Letter that is narrow, such as i or l.

Do not assign mnemonics to commands that are not included on menus, such as the Finish, Cancel, or Next command buttons.

KDE

There's a massive list of global accelerators here (http://techbase.kde.org/Projects/Usability/HIG/Keyboard_Accelerators).

aengelke · 2014-03-01T16:39:23Z

There is a syntax error in Toolkit.java:236. The line should be commented out.

GKFX · 2014-03-01T17:14:01Z

@aengelke I compiled it! algorithmicAssaignment: is a label, for my continue statements. I used labeled continues because it was a tangled mess of if{if{if{else{if{if{if{else{if{if{if{else{}}}}}}}}}}} before.

GKFX · 2014-03-09T12:14:06Z

OK, I've found the proper MS stuff: http://msdn.microsoft.com/en-us/library/windows/desktop/bb545460.aspx#accessKeys. There's a table of defaults, and then:

Prefer characters with wide widths, such as w, m, and capital letters.

Prefer a distinctive consonant or a vowel, such as "x" in "Exit."

Avoid using characters that make the underline difficult to see, such as (from most problematic to least problematic):

Characters that are only one pixel wide, such as i and l.

Characters with descenders, such as g, j, p, q, and y.

Characters next to a letter with a descender.

~~When assigning access keys in wizard pages, remember to reserve "B" for Back and "N" for Next.~~

~~When assigning access keys in property pages, remember to reserve "A" for Apply, if used.~~
Menu access keys

Assign access keys to all menu items. No exceptions.

For dynamic menu items (such as recently used files), assign access keys numerically.

In this example, the Paint program in Windows assigns numeric access keys to recently used files.

Assign unique access keys within a menu level. You can reuse access keys across different menu levels.

Make access keys easy to find:

For the most frequently used menu items, choose characters at the beginning of the first or second word of the label, preferably the first character.

For less frequently used menu items, choose letters that are a distinctive consonant or a vowel in the label.

benfry · 2014-03-30T14:19:25Z

app/src/processing/app/Editor.java

@@ -2671,6 +2670,10 @@ public void actionPerformed(ActionEvent e) {
          }
        });
      this.add(referenceItem);
+
+      Toolkit.setMenuMnemonics(cutItem, copyItem, discourseItem,


Rather than making all these messy local variables, why not just call Toolkit.setMenuMnemonics(this)?

I wanted to, but I couldn't figure out how to get JMenuItems out of a JPopupMenu without dubious casting. If you know how to, feel free to do it.

benfry · 2014-03-30T14:21:17Z

Thanks for the patch—I've added a handful of comments but we should be able to get an alternate version of this incorporated soon.

benfry · 2014-03-30T14:22:56Z

app/src/processing/app/Toolkit.java

+   * Disabled on Mac, per Apple guidelines.
+   * <tt>menu</tt> may contain nulls.
+   *
+   * Author: George Bateman. Initial work Myer Nore.


Since this involves someone else's work, are we sure that the code can be licensed as Processing code? (i.e. the license of the original source isn't incompatible)

They submitted it as a changed form of one of your files (Editor.java). That sounded like they were implying you had permission to take it as part of the project.
(http://processing.org/bugs/bugzilla/attachments/304 from http://processing.org/bugs/bugzilla/26.html)

Ok, just making sure it wasn't a KDE dev or something like that...

Null-check.

Spacing as requested

GKFX · 2014-03-31T15:56:08Z

OK. Thanks for reading over it.

Javadoc bug

I just found out that jmi.getText() can be null, so I added null-checking.

benfry · 2014-07-30T16:34:33Z

We'll need to re-evaluate this once #2084 is integrated.

GKFX · 2014-07-30T20:24:54Z

I designed this with internationalization in mind (but didn't test or work too hard on that aspect). Obviously it accepts arbitrary text in any language, and it will also only associate ASCII mnemonics, to ensure they can be typed (no ctrl+á). But I could have missed things so we'll need to double-check it all.

GKFX · 2014-08-02T15:48:34Z

I have read the code again. I think it is internationalization ready, but I will test it in a few languages to check.

…o mnem-patch Not quite done yet - temporary commit. Conflicts: app/src/processing/app/Editor.java app/src/processing/app/Mode.java app/src/processing/app/Toolkit.java

GKFX · 2014-08-24T13:11:30Z

OK. I managed to implement Toolkit.setMenuMnemonics(JPopupMenu) in the end, which helped a lot with Java 3 mode integration. I tested it in German:

Only problem here is that the Germans seem to use a smaller set of frequent letters, leaving Beenden without a mnemonic. It does have Ctrl+Q though, and there is no repeat of the problem in other menus.
In non-Latin alphabets, I'm out of my depth, and I can't possibly test anything, so the only mnemonics are on snippets of ASCII that do appear.

Merge menu mnemonics back with current code and integrate with PDE-X.

GKFX · 2014-08-24T13:23:43Z

Only thing left is a bit of the sketch menu.

Added Toolkit.setMenuMnemsInside(); removed Editor.resetMenuMnemonics(); added mnemonics to sketches in Sketch menu.

GKFX · 2014-08-25T16:04:44Z

@benfry Done!

benfry · 2014-11-14T22:34:46Z

Sorry, once more...

…o mnem-patch Conflicts: pdex/src/processing/mode/experimental/DebugEditor.java

Also condense some code.

GKFX · 2014-11-18T19:27:26Z

I fixed a little bug in #2834, so to avoid complications I've tagged it on the end of this, seeing as the issues are interlinked.

Dynamically add menu mnemonics to all menus

benfry · 2014-11-18T22:12:06Z

Thanks... merging this now so it can have some time to bake as we prepare for the next release. Thanks very much for your help and for keeping the patch up to date.

github-actions · 2021-06-15T14:06:24Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

GKFX added 2 commits February 25, 2014 19:51

Menu mnemonics processing#51

17e3948

Added Toolkit.setMenuMnemonics(JMenuItem...) and Toolkit.setMenuMnemonics(JMenuBar).

Finalize processing#51 fix

beb190f

benfry reviewed Mar 30, 2014
View reviewed changes

GKFX added 2 commits March 31, 2014 16:53

Update Editor.java

f929af1

Null-check.

Update Toolkit.java

03de2da

Spacing as requested

GKFX added 2 commits April 2, 2014 17:16

Update Toolkit.java

f26e180

Javadoc bug

Menu mnemonic bug fix

6bf0b68

I just found out that jmi.getText() can be null, so I added null-checking.

GKFX changed the title ~~Dynamically add menu mnemonics to all menus~~ [wip] Dynamically add menu mnemonics to all menus Aug 13, 2014

Merge branch 'master' of https://github.com/processing/processing int…

5254e1a

…o mnem-patch Not quite done yet - temporary commit. Conflicts: app/src/processing/app/Editor.java app/src/processing/app/Mode.java app/src/processing/app/Toolkit.java

Menu mnemonics merge

b6c1c74

Merge menu mnemonics back with current code and integrate with PDE-X.

GKFX force-pushed the mnem-patch branch from f1f39fe to b6c1c74 Compare August 24, 2014 13:15

Finalise menu mnemonics

9304db5

Added Toolkit.setMenuMnemsInside(); removed Editor.resetMenuMnemonics(); added mnemonics to sketches in Sketch menu.

GKFX changed the title ~~[wip] Dynamically add menu mnemonics to all menus~~ Dynamically add menu mnemonics to all menus Aug 25, 2014

benfry force-pushed the master branch from e03d591 to 635fb99 Compare September 12, 2014 21:45

GKFX mentioned this pull request Oct 10, 2014

Cut and Copy in the edit menu are active only if some text is selected #2834

Merged

GKFX mentioned this pull request Oct 28, 2014

Miscellaneous fixes #2865

Merged

GKFX added 3 commits November 18, 2014 18:14

Merge branch 'master' of https://github.com/processing/processing int…

c898372

…o mnem-patch Conflicts: pdex/src/processing/mode/experimental/DebugEditor.java

Fix tiny German menumnemonics bug.

eefe062

Translate cut and copy in the edit menu.

2114f6e

Also condense some code.

benfry added a commit that referenced this pull request Nov 18, 2014

Merge pull request #2382 from GKFX/mnem-patch

f895ad0

Dynamically add menu mnemonics to all menus

benfry merged commit f895ad0 into processing:master Nov 18, 2014

benfry mentioned this pull request Nov 18, 2014

add menu mnemonics for editor #51

Closed

GKFX deleted the mnem-patch branch July 3, 2015 17:29

github-actions bot locked as resolved and limited conversation to collaborators Jun 15, 2021

Uh oh!

Dynamically add menu mnemonics to all menus #2382

Dynamically add menu mnemonics to all menus #2382

Uh oh!

Conversation

GKFX commented Mar 1, 2014

Uh oh!

GKFX commented Mar 1, 2014

Human Interface Guidelines

Mac

Gnome

Microsoft

KDE

Uh oh!

aengelke commented Mar 1, 2014

Uh oh!

GKFX commented Mar 1, 2014

Uh oh!

GKFX commented Mar 9, 2014

Uh oh!

benfry Mar 30, 2014

Choose a reason for hiding this comment

Uh oh!

GKFX Mar 31, 2014

Choose a reason for hiding this comment

Uh oh!

benfry commented Mar 30, 2014

Uh oh!

benfry Mar 30, 2014

Choose a reason for hiding this comment

Uh oh!

GKFX Mar 31, 2014

Choose a reason for hiding this comment

Uh oh!

benfry Mar 31, 2014

Choose a reason for hiding this comment

Uh oh!

GKFX commented Mar 31, 2014

Uh oh!

benfry commented Jul 30, 2014

Uh oh!

GKFX commented Jul 30, 2014

Uh oh!

GKFX commented Aug 2, 2014

Uh oh!

GKFX commented Aug 24, 2014

Uh oh!

GKFX commented Aug 24, 2014

Uh oh!

GKFX commented Aug 25, 2014

Uh oh!

benfry commented Nov 14, 2014

Uh oh!

GKFX commented Nov 18, 2014

Uh oh!

benfry commented Nov 18, 2014

Uh oh!

github-actions bot commented Jun 15, 2021

Uh oh!

Uh oh!