com.inductiveautomation.ignition.common.config

Interface CategorizedProperty<T>

All Superinterfaces:

DescriptiveProperty<T>, Property<T>, java.io.Serializable

All Known Subinterfaces:

NotificationProfileProperty<T>

All Known Implementing Classes:

BasicCategorizedProperty, BasicNotificationProfileProperty

public interface CategorizedProperty<T>
extends DescriptiveProperty<T>

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 and Description
static class	CategorizedProperty.Option<T>

Method Summary

Modifier and Type	Method and Description
java.util.List<CategorizedProperty.Option<T>>	getOptions() 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 Detail

getOptions

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

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.