ecologylab.appframework.types.prefs
Class MetaPrefString

java.lang.Object
  extended by ecologylab.generic.Debug
      extended by ecologylab.xml.ElementState
          extended by ecologylab.appframework.types.prefs.MetaPref<java.lang.String>
              extended by ecologylab.appframework.types.prefs.MetaPrefString
All Implemented Interfaces:
WidgetTypes, OptimizationTypes, XMLTranslationExceptionTypes

public class MetaPrefString
extends MetaPref<java.lang.String>

Metadata about a String Preference. Defines information to enable editing the Preference.

Author:
andruid

Nested Class Summary
 
Nested classes/interfaces inherited from class ecologylab.xml.ElementState
ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag
 
Field Summary
static ScalarType STRING_SCALAR_TYPE
           
 
Fields inherited from class ecologylab.xml.ElementState
CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER
 
Fields inherited from interface ecologylab.appframework.types.prefs.WidgetTypes
CHECK_BOX, COLOR_CHOOSER, DROP_DOWN, FILE_CHOOSER, RADIO_BUTTONS, SLIDER, SPINNER, TEXT_AREA, TEXT_FIELD
 
Fields inherited from interface ecologylab.xml.OptimizationTypes
BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED
 
Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes
FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN
 
Constructor Summary
MetaPrefString()
          Instantiate.
 
Method Summary
 java.lang.String getDefaultValue()
          Gets the default value of a MetaPref.
 java.lang.String getInstance(java.lang.String string)
           
 java.lang.String getMaxValue()
          Get max value; returns null for this type.
 java.lang.String getMinValue()
          Get min value; returns null for this type.
protected  Pref<java.lang.String> getPrefInstance()
          Construct a new instance of the Pref that matches this.
 
Methods inherited from class ecologylab.appframework.types.prefs.MetaPref
getAssociatedPref, getCategory, getChoiceByIndex, getChoiceByValue, getChoiceNameByIndex, getChoiceNameByValue, getChoices, getDefaultPrefInstance, getDescription, getHelpText, getID, getIndexByChoice, getIndexByValue, getValueChangedListener, hasChoices, lookup, print, setValueChangedListener, setValueChangedListener, widgetIsCheckBox, widgetIsColorChooser, widgetIsDropDown, widgetIsFileChooser, widgetIsRadio, widgetIsSlider, widgetIsSpinner, widgetIsTextField
 
Methods inherited from class ecologylab.xml.ElementState
addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML
 
Methods inherited from class ecologylab.generic.Debug
classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

STRING_SCALAR_TYPE

public static final ScalarType STRING_SCALAR_TYPE
Constructor Detail

MetaPrefString

public MetaPrefString()
Instantiate.

Method Detail

getDefaultValue

public java.lang.String getDefaultValue()
Gets the default value of a MetaPref.

Specified by:
getDefaultValue in class MetaPref<java.lang.String>
Returns:
Default value of MetaPref

getPrefInstance

protected Pref<java.lang.String> getPrefInstance()
Construct a new instance of the Pref that matches this. Use this to fill-in the default value.

Specified by:
getPrefInstance in class MetaPref<java.lang.String>
Returns:

getMaxValue

public java.lang.String getMaxValue()
Get max value; returns null for this type.

Specified by:
getMaxValue in class MetaPref<java.lang.String>
Returns:
Max value of a MetaPref

getMinValue

public java.lang.String getMinValue()
Get min value; returns null for this type.

Specified by:
getMinValue in class MetaPref<java.lang.String>
Returns:
Min value of a MetaPref

getInstance

public java.lang.String getInstance(java.lang.String string)
Overrides:
getInstance in class MetaPref<java.lang.String>