Package com.inductiveautomation.ignition.common.config

Class ConfigurationProperty.CustomEditorDescriptor

java.lang.Object
com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor
All Implemented Interfaces:
Serializable
Enclosing interface:
ConfigurationProperty<T>
public static final class ConfigurationProperty.CustomEditorDescriptor extends Object implements Serializable
Configuration properties can define custom editors. This class is used to describe the class and version of the editor, since many properties are defined in the gateway scope (or on a different gateway, through the gateway network). For a property to be editable, the editor must be present in the designer, and of a compatible version. Version handling is done by the CustomPropertyEditor class that the specified editor must extend from.
See Also:

  • Constructor Details

    • CustomEditorDescriptor

      public CustomEditorDescriptor(String className)
      Specifies the editor class to use, which must extend from CustomPropertyEditor.
      Parameters:
      className - must extend from CustomPropertyEditor, and must be available in the designer scope.

    • CustomEditorDescriptor

      public CustomEditorDescriptor(String className, int version)
      Specifies the editor class to use, which must extend from CustomPropertyEditor.
      Parameters:
      className - must extend from CustomPropertyEditor, and must be available in the designer scope.
      version - a version of the editor, so that the designer will know when a property comes from an older or newer gateway that may not be compatible.

  • Method Details

    • getClassName

      public String getClassName()

    • getVersion

      public int getVersion()