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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	SoundConfigurer.AudioClipFactory

Nested classes/interfaces inherited from class VASSAL.configure.Configurer

Configurer.ContextLevel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT

Fields inherited from class VASSAL.configure.Configurer

changeSupport, context, contextLevel, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value

Constructor Summary

Constructors

Constructor	Description
SoundConfigurer(String key, String name, String defaultResource)

Method Summary

Modifier and Type	Method	Description
void	chooseClip()
protected SoundConfigurer.AudioClipFactory	createAudioClipFactory()
Component	getControls()	GUI interface for setting the option in an editing window
String	getValueString()
void	play()
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setValue(String s)	Set the Object value from a String

Methods inherited from class VASSAL.configure.Configurer

addFocusListener, addPropertyChangeListener, fireUpdate, getContext, getContextLevel, getHint, getKey, getName, getScreenSize, getValue, initCustomControls, isFrozen, isHighlighted, isPieceContext, removeFocusListener, removePropertyChangeListener, repack, repack, requestFocus, setContext, setContext, setContext, setContextLevel, setEnabled, setFrozen, setHighlighted, setHint, setHintKey, setLabelVisibile, setName, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final String DEFAULT

See Also:

• Constant Field Values

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