Interface ConfigurationProperty<T>
- All Superinterfaces:
DescriptiveProperty<T>
,Property<T>
,Serializable
- All Known Subinterfaces:
NotificationProfileProperty<T>
- All Known Implementing Classes:
BasicConfigurationProperty
,BasicNotificationProfileProperty
An extension of
DescriptiveProperty
that also provides a list of the possible values for the property as
well.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
Configuration properties can define custom editors.static final class
-
Method Summary
Modifier and TypeMethodDescriptionReturns a descriptor for the custom editor used for this property.If this returns a non-null value then a drop-down menu ofConfigurationProperty.Option
s 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
Optional<List<ConfigurationProperty.Option<T>>> getOptions()If this returns a non-null value then a drop-down menu ofConfigurationProperty.Option
s will be displayed to the user.- Returns:
- A list of
ConfigurationProperty.Option
s to display, or Optional.empty() if this property doesn't need a drop-down.
-
getCustomEditor
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
-