Class AnnotatedString


  • public class AnnotatedString
    extends java.lang.Object
    Class to handle Strings annotated with embedded mnemonics Note: Since the human interface guidelines for Mac OS X say never to use mnemonics, this class behaves as if no mnemonics are set when run on Mac OS X.
    • Constructor Summary

      Constructors 
      Constructor Description
      AnnotatedString​(java.lang.String s)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getMnemonic()
      Return the appropriate mnemonic character for this string.
      int getMnemonicIndex()  
      static void localiseButton​(javax.swing.AbstractButton button, java.lang.String key, java.lang.String defaultString, boolean setMnemonic)
      Localise the given AbstractButton, setting the text and optionally mnemonic Note that AbstractButton includes menus and menu items.
      static void main​(java.lang.String[] args)  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AnnotatedString

        public AnnotatedString​(java.lang.String s)
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getMnemonic

        public int getMnemonic()
        Return the appropriate mnemonic character for this string. If no mnemonic should be displayed, KeyEvent.VK_UNDEFINED is returned.
        Returns:
        the Mnemonic character, or VK_UNDEFINED if no mnemonic should be set
      • getMnemonicIndex

        public int getMnemonicIndex()
        Returns:
        the index in the plain string at which the mnemonic should be displayed, or -1 if no mnemonic should be set
      • main

        public static void main​(java.lang.String[] args)
      • localiseButton

        public static void localiseButton​(javax.swing.AbstractButton button,
                                          java.lang.String key,
                                          java.lang.String defaultString,
                                          boolean setMnemonic)
        Localise the given AbstractButton, setting the text and optionally mnemonic Note that AbstractButton includes menus and menu items.
        Parameters:
        button - The button to localise
        key - The key to look up in resource bundle
        defaultString - default String to use if key not found
        setMnemonic - whether or not to set the mnemonic. According to Sun's guidelines, default/cancel buttons should not have mnemonics but instead should use Return/Escape