|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.config.ConfigKey<Subrange>
uk.ac.starlink.ttools.plot2.config.SubrangeConfigKey
public class SubrangeConfigKey
Config key that specifies a Subrange.
Constructor Summary | |
---|---|
SubrangeConfigKey(ConfigMeta meta)
Constructs a key with the usual default. |
|
SubrangeConfigKey(ConfigMeta meta,
Subrange dflt,
double vmin,
double vmax)
Constructs a key with a given default. |
Method Summary | |
---|---|
static ConfigMeta |
createAxisSubMeta(String axname,
String axisName)
Returns a metadata object to describe a SubrangeConfigKey for use with a coordinate axis. |
static ConfigMeta |
createShaderClipMeta(String axname,
String axisName)
Returns a metadaa object to describe a SubrangeConfigKey for use as a restriction on a colour ramp (Shader). |
Specifier<Subrange> |
createSpecifier()
Constructs a graphical control with which the user can specify a suitable value for association with this key. |
Subrange |
stringToValue(String txt)
Decodes a string value to the value type of this key. |
String |
valueToString(Subrange value)
Reports a value as a string. |
Methods inherited from class uk.ac.starlink.ttools.plot2.config.ConfigKey |
---|
cast, getDefaultValue, getMeta, getValueClass, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SubrangeConfigKey(ConfigMeta meta, Subrange dflt, double vmin, double vmax)
vmin
and vmax
parameters
do not impose any hard limits on the value associated with this key,
but they influence the values offered by the Specifier component.
meta
- metadatadflt
- default subrangevmin
- minimum value suggested by GUIvmax
- maximum value suggested by GUIpublic SubrangeConfigKey(ConfigMeta meta)
meta
- metadataMethod Detail |
---|
public String valueToString(Subrange value)
ConfigKey
stringToValue(valueToString(v)).equals(v)
.
A null value, if permitted, should be represented as an empty string.
valueToString
in class ConfigKey<Subrange>
value
- possible value associated with this key
public Subrange stringToValue(String txt) throws ConfigException
ConfigKey
stringToValue
in class ConfigKey<Subrange>
txt
- string representation of value
ConfigException
public Specifier<Subrange> createSpecifier()
ConfigKey
createSpecifier
in class ConfigKey<Subrange>
public static ConfigMeta createAxisSubMeta(String axname, String axisName)
axname
- abbreviated axis name (for CLI)axisName
- full axis name (for GUI)
public static ConfigMeta createShaderClipMeta(String axname, String axisName)
axname
- abbreviated axis name (for CLI)axisName
- full axis name (for GUI)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |