com.inductiveautomation.ignition.common.config

Class ConfigurationProperty.CustomEditorDescriptor

java.lang.Object

com.inductiveautomation.ignition.common.config.ConfigurationProperty.CustomEditorDescriptor

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ConfigurationProperty<T>

public static final class ConfigurationProperty.CustomEditorDescriptor
extends java.lang.Object
implements java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomEditorDescriptor(java.lang.String className) Specifies the editor class to use, which must extend from CustomPropertyEditor.
CustomEditorDescriptor(java.lang.String className, int version) Specifies the editor class to use, which must extend from CustomPropertyEditor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName()
int	getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomEditorDescriptor

public CustomEditorDescriptor(java.lang.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(java.lang.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 Detail

getClassName

public java.lang.String getClassName()

getVersion

public int getVersion()