public class PerUnitConfigKey<U extends Unit> extends OptionConfigKey<U>
Combiner.Type
,
so it can work in concert with a Combiner config key to provide
a more comprehensible GUI.
If the Combiner is not density-like, then this selector is
irrelevant, and so the GUI component is disabled.
Client PlotLayers should assemble ReportMaps with the ReportKey
from this ConfigKeys'
getCombinerTypeReportKey()
method filled in appropriately.Constructor | Description |
---|---|
PerUnitConfigKey(ConfigMeta meta,
java.lang.Class<U> clazz,
U[] options,
U dflt) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
Specifier<U> |
createSpecifier() |
Constructs a graphical control with which the user can
specify a suitable value for association with this key.
|
ReportKey<Combiner.Type> |
getCombinerTypeReportKey() |
Returns a ReportKey that client PlotLayers should fill in
when generating their ReportMap.
|
java.lang.String |
getXmlDescription(U unit) |
Returns a description in XML of the given option value.
|
cast, getDefaultValue, getMeta, getValueClass, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addOptionsXml, getOptions, getOptionsXml, setOptionUsage, stringToValue, valueToString
public PerUnitConfigKey(ConfigMeta meta, java.lang.Class<U> clazz, U[] options, U dflt)
meta
- metadataclazz
- class to which all the possible options belongoptions
- array of possible values for this keydflt
- default option, should be one of options
public ReportKey<Combiner.Type> getCombinerTypeReportKey()
public java.lang.String getXmlDescription(U unit)
OptionConfigKey
OptionConfigKey.valueToString(T)
,
is used by the OptionConfigKey.getOptionsXml()
method to assemble
a described list of the options.getXmlDescription
in class OptionConfigKey<U extends Unit>
unit
- possible value of this keypublic Specifier<U> createSpecifier()
ConfigKey
createSpecifier
in class OptionConfigKey<U extends Unit>
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.