Package com.inductiveautomation.ignition.common.config

Class BasicCategorizedProperty<T>

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicProperty<T>

com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty<T>

com.inductiveautomation.ignition.common.config.BasicCategorizedProperty<T>

All Implemented Interfaces:

CategorizedProperty<T>, DescriptiveProperty<T>, Property<T>, Serializable

@Deprecated(forRemoval=true,
            since="8.1.49")
public class BasicCategorizedProperty<T>
extends BasicDescriptiveProperty<T>
implements CategorizedProperty<T>

Deprecated, for removal: This API element is subject to removal in a future version.

deprecated for removal in a future version. this class is only kept around for legacy deserialization purposes. use BasicConfigurationProperty instead.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.config.CategorizedProperty

CategorizedProperty.Option<T>

Constructor Summary

Constructors

Constructor	Description
BasicCategorizedProperty()	Deprecated, for removal: This API element is subject to removal in a future version. Bean compatibility...
BasicCategorizedProperty(String name, String displayNameKey, String categoryKey, Class<T> cls)	Deprecated, for removal: This API element is subject to removal in a future version.
BasicCategorizedProperty(String name, String displayNameKey, String categoryKey, Class<T> cls, T defaultValue)	Deprecated, for removal: This API element is subject to removal in a future version.
BasicCategorizedProperty(String name, String displayNameKey, String categoryKey, String descriptionKey, Class<T> cls, T defaultValue)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
List<CategorizedProperty.Option<T>>	getOptions()	Deprecated, for removal: This API element is subject to removal in a future version. If this returns a non-null value then a drop-down menu of CategorizedProperty.Options will be displayed to the user.
void	setOptions(List<CategorizedProperty.Option<T>> options)	Deprecated, for removal: This API element is subject to removal in a future version.

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

BasicCategorizedProperty

public BasicCategorizedProperty()

Deprecated, for removal: This API element is subject to removal in a future version.

Bean compatibility...

BasicCategorizedProperty

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

Deprecated, for removal: This API element is subject to removal in a future version.

BasicCategorizedProperty

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

Deprecated, for removal: This API element is subject to removal in a future version.

BasicCategorizedProperty

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

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getOptions

public List<CategorizedProperty.Option<T>> getOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: CategorizedProperty

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

Specified by:

getOptions in interface CategorizedProperty<T>

Returns:

A list of CategorizedProperty.Options to display, or null if this property doesn't need a drop-down.

setOptions

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

Deprecated, for removal: This API element is subject to removal in a future version.