Package com.inductiveautomation.ignition.common.config

Class BasicDescriptiveProperty<T>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicConfigurationProperty, ZoneTraitDescriptor

public class BasicDescriptiveProperty<T>
extends BasicProperty<T>
implements DescriptiveProperty<T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BasicDescriptiveProperty()
BasicDescriptiveProperty(Property<T> copy)
BasicDescriptiveProperty(Property<T> copy, java.lang.String categoryKey)
BasicDescriptiveProperty(java.lang.String name, LocalizedString displayName, LocalizedString category, LocalizedString description, java.lang.Class<? extends T> cls, T defaultValue)
BasicDescriptiveProperty(java.lang.String name, java.lang.Class<? extends T> cls)
BasicDescriptiveProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<? extends T> cls)
BasicDescriptiveProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<? extends T> cls, T defaultValue)
BasicDescriptiveProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.String descriptionKey, java.lang.Class<? extends T> cls, T defaultValue)

Method Summary

Modifier and Type	Method	Description
LocalizedString	getCategory()	The category under which this property will be placed when editing.
java.lang.String	getCategoryKey()
LocalizedString	getDescription()	Optional description/documentation for the property.
java.lang.String	getDescriptionKey()
LocalizedString	getDisplayName()	A friendly display name for the property.
java.lang.String	getDisplayNameKey()
void	setCategory(LocalizedString category)
void	setDescription(LocalizedString description)
void	setDisplayName(LocalizedString displayName)

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.Property

getDefaultValue, getName, getType

Constructor Detail

BasicDescriptiveProperty

public BasicDescriptiveProperty()

BasicDescriptiveProperty

public BasicDescriptiveProperty(Property<T> copy)

BasicDescriptiveProperty

public BasicDescriptiveProperty(Property<T> copy,
                                java.lang.String categoryKey)

BasicDescriptiveProperty

public BasicDescriptiveProperty(java.lang.String name,
                                java.lang.String displayNameKey,
                                java.lang.String categoryKey,
                                java.lang.Class<? extends T> cls)

BasicDescriptiveProperty

public BasicDescriptiveProperty(java.lang.String name,
                                java.lang.String displayNameKey,
                                java.lang.String categoryKey,
                                java.lang.Class<? extends T> cls,
                                T defaultValue)

BasicDescriptiveProperty

public BasicDescriptiveProperty(java.lang.String name,
                                java.lang.String displayNameKey,
                                java.lang.String categoryKey,
                                java.lang.String descriptionKey,
                                java.lang.Class<? extends T> cls,
                                T defaultValue)

BasicDescriptiveProperty

public BasicDescriptiveProperty(java.lang.String name,
                                LocalizedString displayName,
                                LocalizedString category,
                                LocalizedString description,
                                java.lang.Class<? extends T> cls,
                                T defaultValue)

BasicDescriptiveProperty

public BasicDescriptiveProperty(java.lang.String name,
                                java.lang.Class<? extends T> cls)

Method Detail

getDisplayName

public LocalizedString getDisplayName()

Description copied from interface: DescriptiveProperty

A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.

Specified by:

getDisplayName in interface DescriptiveProperty<T>

getCategory

public LocalizedString getCategory()

Description copied from interface: DescriptiveProperty

The category under which this property will be placed when editing.

Specified by:

getCategory in interface DescriptiveProperty<T>

getDescription

public LocalizedString getDescription()

Description copied from interface: DescriptiveProperty

Optional description/documentation for the property. May return null if no information is available.

Specified by:

getDescription in interface DescriptiveProperty<T>

setDisplayName

public void setDisplayName(LocalizedString displayName)

setCategory

public void setCategory(LocalizedString category)

getDisplayNameKey

public java.lang.String getDisplayNameKey()

getCategoryKey

public java.lang.String getCategoryKey()

getDescriptionKey

public java.lang.String getDescriptionKey()

setDescription

public void setDescription(LocalizedString description)