Class BasicConfigurationProperty<T>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.config.BasicProperty<T>
-
- com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty<T>
-
- com.inductiveautomation.ignition.common.config.BasicConfigurationProperty<T>
-
- All Implemented Interfaces:
ConfigurationProperty<T>
,DescriptiveProperty<T>
,Property<T>
,java.io.Serializable
- Direct Known Subclasses:
BasicNotificationProfileProperty
public class BasicConfigurationProperty<T> extends BasicDescriptiveProperty<T> implements ConfigurationProperty<T>, java.io.Serializable
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.config.ConfigurationProperty
ConfigurationProperty.CustomEditorDescriptor, ConfigurationProperty.Option<T>
-
-
Constructor Summary
Constructors Constructor Description BasicConfigurationProperty()
Bean compatibility...BasicConfigurationProperty(Property<T> copy)
BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls)
BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls, T defaultValue)
BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.Class<T> cls, T defaultValue)
BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.Class<T> cls, T defaultValue, java.lang.String editorClass)
BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.String baseKey, java.lang.Class<T> cls, T defaultValue)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 ofConfigurationProperty.Option
s will be displayed to the user.java.util.Optional<java.lang.String>
getValueDisplayBaseKey()
If base key is present, then the system will try to display baseKey+str(value) for each allowed option.void
setCustomEditor(ConfigurationProperty.CustomEditorDescriptor desc)
void
setOptions(java.util.List<ConfigurationProperty.Option<T>> options)
-
Methods inherited from class com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty
getCategory, getCategoryKey, getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, setCategory, setDescription, setDisplayName
-
Methods inherited from class com.inductiveautomation.ignition.common.config.BasicProperty
equals, getClazz, getDefaultValue, getName, getType, hashCode, of, setClazz, setClazz_, setDefaultValue, setDefaultValue_, setName, setName_, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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
-
-
-
-
Constructor Detail
-
BasicConfigurationProperty
public BasicConfigurationProperty()
Bean compatibility...
-
BasicConfigurationProperty
public BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls)
-
BasicConfigurationProperty
public BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls, T defaultValue)
-
BasicConfigurationProperty
public BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.Class<T> cls, T defaultValue)
-
BasicConfigurationProperty
public BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.String baseKey, java.lang.Class<T> cls, T defaultValue)
-
BasicConfigurationProperty
public BasicConfigurationProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.Class<T> cls, T defaultValue, java.lang.String editorClass)
-
-
Method Detail
-
getOptions
public java.util.Optional<java.util.List<ConfigurationProperty.Option<T>>> getOptions()
Description copied from interface:ConfigurationProperty
If this returns a non-null value then a drop-down menu ofConfigurationProperty.Option
s will be displayed to the user.- Specified by:
getOptions
in interfaceConfigurationProperty<T>
- Returns:
- A list of
ConfigurationProperty.Option
s to display, or Optional.empty() if this property doesn't need a drop-down.
-
setOptions
public void setOptions(java.util.List<ConfigurationProperty.Option<T>> options)
-
getCustomEditor
public java.util.Optional<ConfigurationProperty.CustomEditorDescriptor> getCustomEditor()
Description copied from interface:ConfigurationProperty
Returns a descriptor for the custom editor used for this property. If not defined, the standard editor will be used.- Specified by:
getCustomEditor
in interfaceConfigurationProperty<T>
-
setCustomEditor
public void setCustomEditor(ConfigurationProperty.CustomEditorDescriptor desc)
-
getValueDisplayBaseKey
public java.util.Optional<java.lang.String> getValueDisplayBaseKey()
If base key is present, then the system will try to display baseKey+str(value) for each allowed option.- Specified by:
getValueDisplayBaseKey
in interfaceConfigurationProperty<T>
-
-