Class FileConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.FileConfigurer

Direct Known Subclasses:

AudioClipConfigurer, DirectoryConfigurer, ImageConfigurer

public class FileConfigurer
extends Configurer

A Configurer for java.io.File values

Nested Class Summary

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

Configurer.ContextLevel

Field Summary

Fields

Modifier and Type	Field	Description
protected ArchiveWriter	archive
protected boolean	editable
protected FileChooser	fc
protected JPanel	p
protected DirectoryConfigurer	startingDirectory
protected JTextField	tf

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
FileConfigurer(String key, String name)
FileConfigurer(String key, String name, DirectoryConfigurer startingDirectory)
FileConfigurer(String key, String name, ArchiveWriter archive)	If a non-null ArchiveWriter is used in the constructor, then invoking setValue(java.lang.Object) on this FileConfigurer will automatically add the file to the archive

Method Summary

Modifier and Type	Method	Description
protected void	addToArchive(File f)
void	chooseNewValue()
Component	getControls()	GUI interface for setting the option in an editing window
File	getFileValue()
String	getValueString()
protected FileChooser	initFileChooser()
boolean	isEditable()
static void	main(String[] args)
void	setEditable(boolean editable)
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setValue(Object o)	Set the Object value
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

Methods inherited from class java.lang.Object

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

Field Details

archive

protected ArchiveWriter archive

p

protected JPanel p

tf

protected JTextField tf

fc

protected FileChooser fc

editable

protected boolean editable

startingDirectory

protected DirectoryConfigurer startingDirectory

Constructor Details

FileConfigurer

public FileConfigurer(String key,
 String name)

FileConfigurer

public FileConfigurer(String key,
 String name,
 DirectoryConfigurer startingDirectory)

Parameters:

key - Configurer key

name - Configurer label

startingDirectory - If non-null, points to a preferences setting that specifies the starting directory for the "Select" button

FileConfigurer

public FileConfigurer(String key,
 String name,
 ArchiveWriter archive)

If a non-null ArchiveWriter is used in the constructor, then invoking setValue(java.lang.Object) on this FileConfigurer will automatically add the file to the archive

Method Details

initFileChooser

protected FileChooser initFileChooser()

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

addToArchive

protected void addToArchive(File f)

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

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

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

chooseNewValue

public void chooseNewValue()

getFileValue

public File getFileValue()

main

public static void main(String[] args)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)