Package org.sm.smtools.application.util

Enum JGUISounds

java.lang.Object
java.lang.Enum<JGUISounds>
org.sm.smtools.application.util.JGUISounds
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JGUISounds>, java.lang.constant.Constable
public enum JGUISounds
extends java.lang.Enum<JGUISounds>
This class contains the filenames of the selected set of GUI sounds.

Note that this is a singleton class, with only one instance allowed.
The sounds' filenames are queries using the JGUISounds.kINSTANCE.getXXX() methods.

Version:
07/08/2019
Author:
Sven Maerivoet

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  JGUISounds.EGUISoundSet
    The different GUI sound sets.

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    kINSTANCE
    The singleton instance.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getButtonSoundFilename()
    Returns the sound filename associated with a button click.
    java.lang.String getChangeLookAndFeelSoundFilename()
    Returns the sound filename associated when the application's look and feel has changed.
    JGUISounds.EGUISoundSet getCurrentSoundSet()
    Returns the currently selected sound set.
    java.lang.String getMenuItemSoundFilename()
    Returns the sound filename associated with a selection of a menu item.
    java.lang.String getMessageDialogSoundFilename()
    Returns the sound filename associated with a message dialog popup.
    java.lang.String getWarningDialogSoundFilename()
    Returns the sound filename associated with a warning dialog popup.
    java.lang.String getWindowEventSoundFilename()
    Returns the sound filename associated when the application's GUI window is iconified or deiconified.
    void selectDefault()
    Selects the default sound set.
    void selectSoundSet​(JGUISounds.EGUISoundSet guiSoundSet)
    Selects a specified sound set.
    static JGUISounds valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static JGUISounds[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • kINSTANCE

      public static final JGUISounds kINSTANCE
      The singleton instance.

  • Method Details

    • values

      public static JGUISounds[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static JGUISounds valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • selectDefault

      public void selectDefault()
      Selects the default sound set.

    • selectSoundSet

      public void selectSoundSet​(JGUISounds.EGUISoundSet guiSoundSet)
      Selects a specified sound set.
      Parameters:
      guiSoundSet - the sound set to use for the GUI

    • getCurrentSoundSet

      public JGUISounds.EGUISoundSet getCurrentSoundSet()
      Returns the currently selected sound set.
      Returns:
      the currently selected sound set

    • getButtonSoundFilename

      public java.lang.String getButtonSoundFilename()
      Returns the sound filename associated with a button click.
      Returns:
      the sound filename associated with a button click

    • getChangeLookAndFeelSoundFilename

      public java.lang.String getChangeLookAndFeelSoundFilename()
      Returns the sound filename associated when the application's look and feel has changed.
      Returns:
      the sound filename associated when the application's look and feel has change

    • getMenuItemSoundFilename

      public java.lang.String getMenuItemSoundFilename()
      Returns the sound filename associated with a selection of a menu item.
      Returns:
      the sound filename associated with a selection of a menu item

    • getMessageDialogSoundFilename

      public java.lang.String getMessageDialogSoundFilename()
      Returns the sound filename associated with a message dialog popup.
      Returns:
      the sound filename associated with a message dialog popup

    • getWarningDialogSoundFilename

      public java.lang.String getWarningDialogSoundFilename()
      Returns the sound filename associated with a warning dialog popup.
      Returns:
      the sound filename associated with a warning dialog popup

    • getWindowEventSoundFilename

      public java.lang.String getWindowEventSoundFilename()
      Returns the sound filename associated when the application's GUI window is iconified or deiconified.
      Returns:
      the sound filename associated when the application's GUI window is iconified or deiconified