Package oracle.stellent.ridc.i18n.utils

Class MnemonicUtil

java.lang.Object
oracle.stellent.ridc.i18n.utils.MnemonicUtil
public class MnemonicUtil extends Object
Mnemonic utility class

  • Field Details

    • MNEMONIC_INDICATOR

      public static final char MNEMONIC_INDICATOR
      Constant for the mnemonic indicator '&'.
      See Also:

    • OPENING_PARENTHESIS

      public static final char OPENING_PARENTHESIS
      Constant for the opening parenthesis (=left parenthesis) '('.
      See Also:

    • CLOSING_PARENTHESIS

      public static final char CLOSING_PARENTHESIS
      Constant for the closing parenthesis (=right parenthesis) ')'.
      See Also:

  • Constructor Details

    • MnemonicUtil

      public MnemonicUtil()

  • Method Details

    • getMnemonicCharacter

      public static int getMnemonicCharacter(String labelAndMnemonic) throws NullPointerException
      Gets the keyboard mnemonic from label and mnemonic text. Mnemonic character is indicated by MNEMONIC_INDICATOR. If label and mnemonic text contains two or more mnemonic indicator, second and after appearance of mnemonic indicators are ignored.

      For example,

      From To
      &File  →  F
      ファイル(&F)  →  F

      Parameters:
      labelAndMnemonic - label text containing mnemonic
      Returns:
      an int specifying the accelerator key. 0, if no mnemonic characterr in this string
      Throws:
      NullPointerException - if labelAndMnemonic is null

    • getMnemonicIndex

      public static int getMnemonicIndex(String labelAndMnemonic) throws NullPointerException

      Gets the index of the mnemonic from label and mnemonic text.

      For example,

      From To
      &File  →  F
      ファイル(&F)  →  F

      Parameters:
      labelAndMnemonic - label text containing mnemonic
      Returns:
      an int specifying the accelerator key index. 0, if no mnemonic characterr in this string
      Throws:
      NullPointerException - if labelAndMnemonic is null

    • extractLabelTextWithMnemonic

      public static String extractLabelTextWithMnemonic(String labelAndMnemonic) throws NullPointerException
      Extracts label text by removing non-displayable mnemonic indicator (conventionally ampersand (' ')) from label text and mnemonic resource. If label and mnemonic text contains two or more mnemonic indicator, second and after appearance of mnemonic indicators are ignored.

      For example,

      From To
      &File  →  File
      ファイル(&F)  →  ファイル(F)

      Parameters:
      labelAndMnemonic - label text containing mnemonic
      Returns:
      label text without mnemonic
      Throws:
      NullPointerException - if labelAndMnemonic is null

    • addMnemonicToLabel

      public static String addMnemonicToLabel(String label, char mnemonic) throws NullPointerException
      Returns label text with mnemonic character enclosed in parenthesis. If the label does not contain mnemonic character (ignoring case), mnemonic character is enclosed in parenthesis and added end of menu label. If mnemonic is not a valid character for mnemonic key, only label will be returned.

      When you need menu label for CJK translation (or translated menu label does not contain mnemonic character), you have to add mnemonic label after menu label text. The mnemonic character should be enclosed in parenthesis and added end of menu label for CJK translation.

      For example,

      From To
      F  +  ファイル  →  ファイル(F)

      Parameters:
      label -
      mnemonic -
      Returns:
      label text with mnemonic
      Throws:
      NullPointerException - if labelAndMnemonic is null

    • extractLabelTextWithoutMnemonic

      public static String extractLabelTextWithoutMnemonic(String labelAndMnemonic) throws NullPointerException
      Extracts label text by removing mnemonic characters (e.g., "(F)" and "(&F)") from label text resource containing mnemonic.
      • strip mnemonic indicator from menu label text and mnemonic resource
      • strip mnemonic label (from opening parenthesis to closing parenthesis that containing mnemonic indicator and mnemonic character)for CJK translation
      • strip mnemonic label (from opening parenthesis to closing parenthesis that containing mnemonic character) without mnemonic indicator for CJK translation

      For example,

      From To
      &File  →  File
      ファイル(&F)  →  ファイル
      ファイル(F)  →  ファイル

      Conventionally, mnemonic indicator is ampersand ('&') and mnemonic character for CJK translation is enclosed by OPENING_PARENTHESIS ('(') and CLOSING_PARENTHESIS (')').

      If label and mnemonic text contains two or more mnemonic indicator, second and after appearance of mnemonic indicators are ignored.
      If parenthesis are not enclosing only mnemonic character, parenthesis are not removed.
      If mnemonic indicator is not found in CJK translation resource, last occurrence of the parenthesis and enclosed mnemonic character will be removed.

      Parameters:
      labelAndMnemonic -
      Returns:
      label text without mnemonic
      Throws:
      NullPointerException - if labelAndMnemonic is null

    • setTextAndMnemonic

      public static void setTextAndMnemonic(AbstractButton button, LocaleMessage buttonText)
      Set label text and keyboard mnemonic of specified this component
      Parameters:
      button - component to set label text and mnemonic
      buttonText - label text with mnemonic character

    • setLabelAndTextFor

      public static void setLabelAndTextFor(JLabel label, Component labelFor, LocaleMessage labelText)

    • isValidMnemonicKey

      public static boolean isValidMnemonicKey(int key)
      Returns true if key is an valid mnemonic key based on mnemonic key validator associated with thid class.
      Parameters:
      key - mnemonic key
      Returns:
      true if key is valid mnemonic key, else false

    • setMnemonicKeyValidator

      public static void setMnemonicKeyValidator(MnemonicKeyValidator mnemonicKeyValidator)

    • getMnemonicKeyValidator

      public static MnemonicKeyValidator getMnemonicKeyValidator()