Class BasicAlarmProperty<T>
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty<T>
-
- All Implemented Interfaces:
AlarmProperty<T>
,DescriptiveProperty<T>
,Property<T>
,java.io.Serializable
public class BasicAlarmProperty<T> extends java.lang.Object implements AlarmProperty<T>
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BasicAlarmProperty()
BasicAlarmProperty(AlarmProperty<T> base, java.lang.String displayKey)
BasicAlarmProperty(java.lang.String name, java.lang.Class<? extends T> type, T defaultVal, java.lang.String displayKey, java.lang.String categoryKey, java.lang.String descKey, boolean bindable, boolean advanced)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
LocalizedString
getCategory()
The category under which this property will be placed when editing.java.lang.String
getCategoryKey()
T
getDefaultVal()
T
getDefaultValue()
The default value for new instances of this property, or null if not applicable.java.lang.String
getDescKey()
LocalizedString
getDescription()
Optional description/documentation for the property.java.lang.String
getDisplayKey()
LocalizedString
getDisplayName()
A friendly display name for the property.java.lang.String
getName()
The "name" of this property.java.lang.Class<? extends T>
getType()
The data type for this property.int
hashCode()
boolean
isAdvanced()
Indicates whether this property should not be shown on basic edit screens.boolean
isBindable()
Indicates whether this property is allowed to be bound.void
setAdvanced(boolean advanced)
void
setBindable(boolean bindable)
void
setCategoryKey(java.lang.String categoryKey)
void
setDefaultVal(T defaultVal)
void
setDescKey(java.lang.String descKey)
void
setDisplayKey(java.lang.String displayKey)
void
setName(java.lang.String name)
void
setType(java.lang.Class<? extends T> type)
java.lang.String
toString()
-
-
-
Constructor Detail
-
BasicAlarmProperty
public BasicAlarmProperty()
-
BasicAlarmProperty
public BasicAlarmProperty(AlarmProperty<T> base, java.lang.String displayKey)
-
-
Method Detail
-
getDefaultVal
public T getDefaultVal()
-
setDefaultVal
public void setDefaultVal(T defaultVal)
-
setType
public void setType(java.lang.Class<? extends T> type)
-
setName
public void setName(java.lang.String name)
-
setDisplayKey
public void setDisplayKey(java.lang.String displayKey)
-
setCategoryKey
public void setCategoryKey(java.lang.String categoryKey)
-
setDescKey
public void setDescKey(java.lang.String descKey)
-
setBindable
public void setBindable(boolean bindable)
-
setAdvanced
public void setAdvanced(boolean advanced)
-
getType
public java.lang.Class<? extends T> getType()
Description copied from interface:Property
The data type for this property.
-
getDefaultValue
public T getDefaultValue()
Description copied from interface:Property
The default value for new instances of this property, or null if not applicable.- Specified by:
getDefaultValue
in interfaceProperty<T>
-
getName
public java.lang.String getName()
Description copied from interface:Property
The "name" of this property. Should be descriptive, but also unique. To this end, it is encouraged to make your keys fully qualified by prefixing them with your module id. For example: "mymod.MyProperty". Properties defined by the system start with "sys."
-
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 interfaceDescriptiveProperty<T>
-
getDisplayKey
public java.lang.String getDisplayKey()
-
getCategory
public LocalizedString getCategory()
Description copied from interface:DescriptiveProperty
The category under which this property will be placed when editing.- Specified by:
getCategory
in interfaceDescriptiveProperty<T>
-
getCategoryKey
public java.lang.String getCategoryKey()
-
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 interfaceDescriptiveProperty<T>
-
getDescKey
public java.lang.String getDescKey()
-
isBindable
public boolean isBindable()
Description copied from interface:AlarmProperty
Indicates whether this property is allowed to be bound. If not, only simple values are allowed.- Specified by:
isBindable
in interfaceAlarmProperty<T>
-
isAdvanced
public boolean isAdvanced()
Description copied from interface:AlarmProperty
Indicates whether this property should not be shown on basic edit screens.- Specified by:
isAdvanced
in interfaceAlarmProperty<T>
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-