Package com.inductiveautomation.perspective.common.config

Class ComponentConfig

java.lang.Object
com.inductiveautomation.perspective.common.config.ComponentConfig
public class ComponentConfig extends Object
A Gson serializable representation of a Component definition.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ComponentConfig.RuntimeGsonAdapter
     
    static class 
    ComponentConfig.StandardGsonAdapter
    Custom GSON serializer used to omit empty stuff to keep the serialized components small as possible.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    List<ComponentConfig>
    children
    A component may have children.
    static final Type
    COMPONENT_LIST_TYPE_TOKEN
     
    com.inductiveautomation.ignition.common.gson.JsonObject
    custom
    Custom properties associated with the component, with similar structure to props
    EventConfig
    events
    Contains configuration for how to respond to events.
    com.inductiveautomation.ignition.common.gson.JsonObject
    meta
    Meta properties associated with the component, with similar structure to props.
    com.inductiveautomation.ignition.common.gson.JsonObject
    position
    Positional properties associated with the component, generally specific to a single instance of a component.
    PropertyConfigCollection
    propConfig
    Contains configuration associated with specific properties, e.g.
    com.inductiveautomation.ignition.common.gson.JsonObject
    props
    A map of properties that this component has, where the key is the property key, and the Object represents the value of the property, of an arbitrary type.
    ScriptConfig
    scripts
    Contains scripting configuration for the component like custom methods and message handlers.
    String
    type
    The type of component, as defined when registering the PerspectiveComponentConfig meta object in the client.
    long
    version
    The version of this component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ComponentConfig()
     
    ComponentConfig(long version, String type, com.inductiveautomation.ignition.common.gson.JsonObject props, com.inductiveautomation.ignition.common.gson.JsonObject custom, com.inductiveautomation.ignition.common.gson.JsonObject meta, com.inductiveautomation.ignition.common.gson.JsonObject position, EventConfig events, PropertyConfigCollection propConfig, ScriptConfig scripts, List<ComponentConfig> children)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    String
    getName()
     
    int
    hashCode()
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • version

      public long version
      The version of this component.

    • type

      public String type
      The type of component, as defined when registering the PerspectiveComponentConfig meta object in the client.

    • props

      public com.inductiveautomation.ignition.common.gson.JsonObject props
      A map of properties that this component has, where the key is the property key, and the Object represents the value of the property, of an arbitrary type. Values may be a simple primitive value, or represent its own document shape with deeper structure. These properties are generally specific to the component type.

    • custom

      public com.inductiveautomation.ignition.common.gson.JsonObject custom
      Custom properties associated with the component, with similar structure to props

    • meta

      public com.inductiveautomation.ignition.common.gson.JsonObject meta
      Meta properties associated with the component, with similar structure to props. In general, all components have the same set of meta properties.

    • position

      public com.inductiveautomation.ignition.common.gson.JsonObject position
      Positional properties associated with the component, generally specific to a single instance of a component.

    • events

      @Nullable public EventConfig events
      Contains configuration for how to respond to events.

    • propConfig

      @Nullable public PropertyConfigCollection propConfig
      Contains configuration associated with specific properties, e.g. bindings, persistence, etc.

    • scripts

      @Nullable public ScriptConfig scripts
      Contains scripting configuration for the component like custom methods and message handlers.

    • children

      public List<ComponentConfig> children
      A component may have children. This list represents the children of the component.

    • COMPONENT_LIST_TYPE_TOKEN

      public static final Type COMPONENT_LIST_TYPE_TOKEN

  • Constructor Details

    • ComponentConfig

      public ComponentConfig()

    • ComponentConfig

      public ComponentConfig(long version, String type, com.inductiveautomation.ignition.common.gson.JsonObject props, com.inductiveautomation.ignition.common.gson.JsonObject custom, com.inductiveautomation.ignition.common.gson.JsonObject meta, com.inductiveautomation.ignition.common.gson.JsonObject position, EventConfig events, PropertyConfigCollection propConfig, ScriptConfig scripts, List<ComponentConfig> children)

  • Method Details