Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8341560

Better documentation for KeyCombinations/KeyCodes/KeyEvents

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: P4 P4
    • tbd
    • None
    • javafx

      The documentation for KeyCombinations is both incorrect and sparse. The distinction drawn between KeyCharacterCombination and KeyCodeCombination is wrong. The docs say that one is dependent on the keyboard layout and the other isn't (they both are). There's not much explanation of how KeyCharacterCombinations work and no indication of when a developer should use a KeyCharacterCombination instead of a KeyCodeCombination.

      The documentation should also give a brief outline of how KeyCodes are assigned since there's a relationship between these assignments and KeyCodeCombinations. And there are some KeyCodes that should be marked deprecated.

      Though it's not related to shortcut processing it wouldn't hurt to mention that on Mac and Linux dead keys are handled using InputMethod events instead of KeyEvents. This has caused confusion in the past.

            mfox Martin Fox
            mfox Martin Fox
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: