com.inductiveautomation.ignition.common.config

Interface ConfigurationProperty<T>

All Superinterfaces:

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

All Known Subinterfaces:

NotificationProfileProperty<T>

All Known Implementing Classes:

BasicConfigurationProperty, BasicNotificationProfileProperty

public interface ConfigurationProperty<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	ConfigurationProperty.CustomEditorDescriptor Configuration properties can define custom editors.
static class	ConfigurationProperty.Option<T>

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ConfigurationProperty.CustomEditorDescriptor>	getCustomEditor() Returns a descriptor for the custom editor used for this property.
java.util.Optional<java.util.List<ConfigurationProperty.Option<T>>>	getOptions() If this returns a non-null value then a drop-down menu of ConfigurationProperty.Options will be displayed to the user.
java.util.Optional<java.lang.String>	getValueDisplayBaseKey()

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.Optional<java.util.List<ConfigurationProperty.Option<T>>> getOptions()

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

Returns:

A list of ConfigurationProperty.Options to display, or Optional.empty() if this property doesn't need a drop-down.

getCustomEditor

java.util.Optional<ConfigurationProperty.CustomEditorDescriptor> getCustomEditor()

Returns a descriptor for the custom editor used for this property. If not defined, the standard editor will be used.

getValueDisplayBaseKey

java.util.Optional<java.lang.String> getValueDisplayBaseKey()