Package com.inductiveautomation.ignition.common.config

Interface CategorizedProperty<T>

All Superinterfaces:

DescriptiveProperty<T>, Property<T>, Serializable

All Known Implementing Classes:

BasicCategorizedProperty

@Deprecated(forRemoval=true,
            since="8.1.49")
public interface CategorizedProperty<T>
extends DescriptiveProperty<T>

Deprecated, for removal: This API element is subject to removal in a future version.

deprecated for removal in a future version. this class is only kept around for legacy deserialization purposes. use ConfigurationProperty instead.

An extension of DescriptiveProperty that also provides a list of the possible values for the property as well.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CategorizedProperty.Option<T>	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
List<CategorizedProperty.Option<T>>	getOptions()	Deprecated, for removal: This API element is subject to removal in a future version. If this returns a non-null value then a drop-down menu of CategorizedProperty.Options will be displayed to the user.

Methods inherited from interface com.inductiveautomation.ignition.common.config.DescriptiveProperty

getCategory, getDescription, getDisplayName

Methods inherited from interface com.inductiveautomation.ignition.common.config.Property

getDefaultValue, getName, getType

Method Details

getOptions

List<CategorizedProperty.Option<T>> getOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

If this returns a non-null value then a drop-down menu of CategorizedProperty.Options will be displayed to the user.

Returns:

A list of CategorizedProperty.Options to display, or null if this property doesn't need a drop-down.