Package heronarts.lx.parameter

Class StringParameter

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.StringParameter

All Implemented Interfaces:

LXPath, LXParameter

public class StringParameter
extends LXListenableParameter

Parameter which contains a mutable String value.

Nested Class Summary

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields inherited from class heronarts.lx.parameter.LXListenableParameter

description

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
StringParameter(String label)
StringParameter(String label, String string)

Method Summary

Modifier and Type	Method	Description
String	getString()
StringParameter	reset()	A method to reset the value of the parameter, if a default is available.
LXParameter	reset(double value)	Resets the value of the parameter, giving it a new default.
StringParameter	reset(String string)
StringParameter	setDescription(String description)
StringParameter	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
StringParameter	setValue(String string)
StringParameter	setValue(String string, boolean update)
protected double	updateValue(double value)	Invoked when the value has changed.

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, incrementValue, isDefault, isMappable, removeListener, setComponent, setFormatter, setPolarity, setUnits, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.parameter.LXParameter

getBaseValue, getBaseValuef, getValuef

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Constructor Details

StringParameter

public StringParameter(String label)

StringParameter

public StringParameter(String label,
 String string)

Method Details

setDescription

public StringParameter setDescription(String description)

Overrides:

setDescription in class LXListenableParameter

setMappable

public StringParameter setMappable(boolean mappable)

Description copied from interface: LXParameter

Sets whether this parameter should be eligible for MIDI/modulation mapping or not.

Specified by:

setMappable in interface LXParameter

Overrides:

setMappable in class LXListenableParameter

Parameters:

mappable - Whether parameter should be available for mapping

Returns:

this

reset

public StringParameter reset()

Description copied from interface: LXParameter

A method to reset the value of the parameter, if a default is available. Not necessarily defined for all parameters, may be ignored.

Specified by:

reset in interface LXParameter

Overrides:

reset in class LXListenableParameter

Returns:

this

reset

public LXParameter reset(double value)

Description copied from class: LXListenableParameter

Resets the value of the parameter, giving it a new default. Future calls to reset() with no parameter will use this value.

Overrides:

reset in class LXListenableParameter

Parameters:

value - New default value

Returns:

this

reset

public StringParameter reset(String string)

setValue

public StringParameter setValue(String string)

setValue

public StringParameter setValue(String string,
 boolean update)

updateValue

protected double updateValue(double value)

Description copied from class: LXListenableParameter

Invoked when the value has changed. Subclasses should update any special internal state according to this new value.

Specified by:

updateValue in class LXListenableParameter

Parameters:

value - New value

Returns:

this

getString

public String getString()