Class SoundConfigurer

java.lang.Object
VASSAL.configure.Configurer
VASSAL.configure.SoundConfigurer

public class SoundConfigurer extends Configurer
Configurer for specifying a Clip. This class is intended to allow players to override a default sound with their own sound file on their local file system.
  • Field Details

  • Constructor Details

    • SoundConfigurer

      public SoundConfigurer(String key, String name, String defaultResource)
  • Method Details

    • getControls

      public Component getControls()
      Description copied from class: Configurer
      GUI interface for setting the option in an editing window
      Specified by:
      getControls in class Configurer
    • getValueString

      public String getValueString()
      Specified by:
      getValueString in class Configurer
      Returns:
      a String representation of the Object value
    • setValue

      public void setValue(String s)
      Description copied from class: Configurer
      Set the Object value from a String
      Specified by:
      setValue in class Configurer
    • createAudioClipFactory

      protected SoundConfigurer.AudioClipFactory createAudioClipFactory()
    • play

      public void play()
    • chooseClip

      public void chooseClip()
    • setLabelVisible

      public void setLabelVisible(boolean visible)
      Description copied from class: Configurer
      Show/Hide the internal label maintained by this Configurer. It is up to individual Configurers to track and hide the label (if they can). This method is currently only utilized by the Preference configs PrefsEditor.addOption(String, Configurer) to extract an existing label in a configurer, display correctly aligned and suppress the original label. This keeps compatibility with custom module code setting up preferences. This method only needs to be implemented in Configurers that are added as preferences.
      Overrides:
      setLabelVisible in class Configurer
      Parameters:
      visible - Hide label if true