Package com.inductiveautomation.ignition.common.config

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>, Serializable

Direct Known Subclasses:

BasicNotificationProfileProperty

public class BasicConfigurationProperty<T>
extends BasicDescriptiveProperty<T>
implements ConfigurationProperty<T>, 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(String name, String displayNameKey, String categoryKey, Class<T> cls)
BasicConfigurationProperty(String name, String displayNameKey, String categoryKey, Class<T> cls, T defaultValue)
BasicConfigurationProperty(String name, String displayNameKey, String categoryKey, String descriptionKey, Class<T> cls, T defaultValue)
BasicConfigurationProperty(String name, String displayNameKey, String categoryKey, String descriptionKey, Class<T> cls, T defaultValue, String editorClass)
BasicConfigurationProperty(String name, String displayNameKey, String categoryKey, String descriptionKey, String baseKey, Class<T> cls, T defaultValue)

Method Summary

Modifier and Type	Method	Description
Optional<ConfigurationProperty.CustomEditorDescriptor>	getCustomEditor()	Returns a descriptor for the custom editor used for this property.
Optional<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.
Optional<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(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 Details

BasicConfigurationProperty

public BasicConfigurationProperty()

Bean compatibility...

BasicConfigurationProperty

public BasicConfigurationProperty(String name,
 String displayNameKey,
 String categoryKey,
 Class<T> cls)

BasicConfigurationProperty

public BasicConfigurationProperty(String name,
 String displayNameKey,
 String categoryKey,
 Class<T> cls,
 T defaultValue)

BasicConfigurationProperty

public BasicConfigurationProperty(String name,
 String displayNameKey,
 String categoryKey,
 String descriptionKey,
 Class<T> cls,
 T defaultValue)

BasicConfigurationProperty

public BasicConfigurationProperty(String name,
 String displayNameKey,
 String categoryKey,
 String descriptionKey,
 String baseKey,
 Class<T> cls,
 T defaultValue)

BasicConfigurationProperty

public BasicConfigurationProperty(String name,
 String displayNameKey,
 String categoryKey,
 String descriptionKey,
 Class<T> cls,
 T defaultValue,
 String editorClass)

BasicConfigurationProperty

public BasicConfigurationProperty(Property<T> copy)

Method Details

getOptions

public Optional<List<ConfigurationProperty.Option<T>>> getOptions()

Description copied from interface: ConfigurationProperty

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

Specified by:

getOptions in interface ConfigurationProperty<T>

Returns:

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

setOptions

public void setOptions(List<ConfigurationProperty.Option<T>> options)

getCustomEditor

public 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 interface ConfigurationProperty<T>

setCustomEditor

public void setCustomEditor(ConfigurationProperty.CustomEditorDescriptor desc)

getValueDisplayBaseKey

public Optional<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 interface ConfigurationProperty<T>