Class AssociatedData
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alarming.config.AssociatedData
-
- All Implemented Interfaces:
AlarmProperty<java.lang.Object>
,DescriptiveProperty<java.lang.Object>
,Property<java.lang.Object>
,java.io.Serializable
public class AssociatedData extends java.lang.Object implements AlarmProperty<java.lang.Object>
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AssociatedData(java.lang.String name, java.lang.Class<?> dtype)
-
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.Object
getDefaultValue()
The default value for new instances of this property, or null if not applicable.LocalizedString
getDescription()
Optional description/documentation for the property.LocalizedString
getDisplayName()
A friendly display name for the property.java.lang.String
getName()
The "name" of this property.java.lang.Class<? extends java.lang.Object>
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.
-
-
-
Method Detail
-
getType
public java.lang.Class<? extends java.lang.Object> getType()
Description copied from interface:Property
The data type for this property.
-
getDefaultValue
public java.lang.Object 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<java.lang.Object>
-
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<java.lang.Object>
-
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<java.lang.Object>
-
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<java.lang.Object>
-
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<java.lang.Object>
-
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<java.lang.Object>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-