Package heronarts.lx.parameter

Class EnumParameter<T extends Enum<T>>

java.lang.Object

heronarts.lx.parameter.LXListenableParameter

heronarts.lx.parameter.LXListenableNormalizedParameter

heronarts.lx.parameter.DiscreteParameter

heronarts.lx.parameter.ObjectParameter<T>

heronarts.lx.parameter.EnumParameter<T>

All Implemented Interfaces:

LXPath, IEnumParameter<T>, LXNormalizedParameter, LXParameter

public class EnumParameter<T extends Enum<T>>
extends ObjectParameter<T>
implements IEnumParameter<T>

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.parameter.DiscreteParameter

DiscreteParameter.IncrementMode

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

LXNormalizedParameter.OscMode

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

Modifier and Type	Field	Description
final Class<T>	enumClass

Fields inherited from class heronarts.lx.parameter.DiscreteParameter

maxValue, minValue, optionsChanged, range

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
EnumParameter(String label, T t)

Method Summary

Modifier and Type	Method	Description
EnumParameter<T>	addListener(LXParameterListener listener)
T	getBaseEnum()
T	getEnum()
EnumParameter<T>	setDescription(String description)
EnumParameter<T>	setEnum(String enumName)
EnumParameter<T>	setIncrementMode(DiscreteParameter.IncrementMode incrementMode)
EnumParameter<T>	setMappable(boolean mappable)	Sets whether this parameter should be eligible for MIDI/modulation mapping or not.
EnumParameter<T>	setWrappable(boolean wrappable)

Methods inherited from class heronarts.lx.parameter.ObjectParameter

getBaseObject, getObject, getObjects, setObjects, setObjects, setRange, setValue

Methods inherited from class heronarts.lx.parameter.DiscreteParameter

decrement, decrement, decrement, decrement, getBaseIndex, getBaseOption, getBaseValuei, getIncrementMode, getIndex, getMaxValue, getMinValue, getNormalized, getOption, getOption, getOptions, getRange, getRangei, getValueFromNormalized, getValuei, increment, increment, increment, increment, normalizedToValue, setFormatter, setFormatter, setIndex, setNormalized, setOptions, setOptions, setOptions, setRange, setRange, setUnits, updateValue

Methods inherited from class heronarts.lx.parameter.LXListenableNormalizedParameter

getExponent, getNormalizedWithModulation, getOscMode, incrementNormalized, incrementNormalized, isWrappable, setExponent, setOscMode

Methods inherited from class heronarts.lx.parameter.LXListenableParameter

addListener, bang, dispose, getDescription, getFormatter, getLabel, getParent, getParentParameter, getPath, getPolarity, getUnits, getValue, incrementValue, isDefault, isMappable, removeListener, reset, reset, setComponent, setPolarity, 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.IEnumParameter

getBaseValuei, getValuei

Methods inherited from interface heronarts.lx.parameter.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getNormalizedf

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

enumClass

public final Class<T extends Enum<T>> enumClass

Constructor Details

EnumParameter

public EnumParameter(String label,
 T t)

Method Details

setEnum

public EnumParameter<T> setEnum(String enumName)

Specified by:

setEnum in interface IEnumParameter<T extends Enum<T>>

setDescription

public EnumParameter<T> setDescription(String description)

Overrides:

setDescription in class ObjectParameter<T extends Enum<T>>

setIncrementMode

public EnumParameter<T> setIncrementMode(DiscreteParameter.IncrementMode incrementMode)

Overrides:

setIncrementMode in class ObjectParameter<T extends Enum<T>>

setMappable

public EnumParameter<T> 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 ObjectParameter<T extends Enum<T>>

Parameters:

mappable - Whether parameter should be available for mapping

Returns:

this

setWrappable

public EnumParameter<T> setWrappable(boolean wrappable)

Overrides:

setWrappable in class ObjectParameter<T extends Enum<T>>

addListener

public EnumParameter<T> addListener(LXParameterListener listener)

Overrides:

addListener in class LXListenableParameter

getBaseEnum

public T getBaseEnum()

Specified by:

getBaseEnum in interface IEnumParameter<T extends Enum<T>>

getEnum

public T getEnum()

Specified by:

getEnum in interface IEnumParameter<T extends Enum<T>>