Class TextConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.TextConfigurer

All Implemented Interfaces:

ConfigurerFactory

public class TextConfigurer
extends Configurer
implements ConfigurerFactory

A Configurer that allows multi-line string input via a JTextArea

Nested Class Summary

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

Configurer.ContextLevel

Field Summary

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
TextConfigurer()
TextConfigurer(String key, String name)
TextConfigurer(String key, String name, String val)
TextConfigurer(String key, String name, String val, boolean wrap)

Method Summary

Modifier and Type	Method	Description
static String	escapeNewlines(String s)	Encodes a string by replacing newlines with '|' characters
Configurer	getConfigurer(AutoConfigurable c, String key, String name)
Component	getControls()	GUI interface for setting the option in an editing window
String	getValueString()
void	requestFocus()	Move the cursor to the first input field of this Configurer
static String	restoreNewlines(String s)	Restores a string by replacing '|' with newlines
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String
void	setWordWrap(boolean b)

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, setContext, setContext, setContext, setContextLevel, setEnabled, setFrozen, setHighlighted, setHint, setHintKey, setLabelVisibile, setLabelVisible, setName

Methods inherited from class java.lang.Object

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

Constructor Details

TextConfigurer

public TextConfigurer()

TextConfigurer

public TextConfigurer(String key,
 String name)

TextConfigurer

public TextConfigurer(String key,
 String name,
 String val)

TextConfigurer

public TextConfigurer(String key,
 String name,
 String val,
 boolean wrap)

Method Details

getConfigurer

public Configurer getConfigurer(AutoConfigurable c,
 String key,
 String name)

Specified by:

getConfigurer in interface ConfigurerFactory

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

setWordWrap

public void setWordWrap(boolean b)

escapeNewlines

public static String escapeNewlines(String s)

Encodes a string by replacing newlines with '|' characters

Parameters:

s -

Returns:

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

restoreNewlines

public static String restoreNewlines(String s)

Restores a string by replacing '|' with newlines

Parameters:

s -

Returns:

requestFocus

public void requestFocus()

Description copied from class: Configurer

Move the cursor to the first input field of this Configurer

Overrides:

requestFocus in class Configurer

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