Package com.inductiveautomation.perspective.designer.api

Interface DesignerComponentStoreBridge

All Superinterfaces:
Changeable
All Known Implementing Classes:
DesignerComponentStoreBridgeImpl
public interface DesignerComponentStoreBridge extends Changeable
Provides a connected to a deeply selected component. Whenever any props or designerState changes on the deeply selected component, this object will fire change and those values will be available in getProps() and getDesignerState()

  • Method Summary

    Modifier and Type
    Method
    Description
    com.inductiveautomation.ignition.common.gson.JsonObject
    getDesignerState()
     
    com.inductiveautomation.ignition.common.gson.JsonObject
    getProps()
     
    void
    updateDesignerState(com.inductiveautomation.ignition.common.gson.JsonElement write)
    Calls updateDesignerState with the given object.
    void
    writeToProps(String path, com.inductiveautomation.ignition.common.gson.JsonElement write)
     

    Methods inherited from interface com.inductiveautomation.ignition.common.util.Changeable

    addChangeListener, removeChangeListener

  • Method Details

    • getProps

      com.inductiveautomation.ignition.common.gson.JsonObject getProps()
      Returns:
      the props of the deeply selected component.

    • getDesignerState

      com.inductiveautomation.ignition.common.gson.JsonObject getDesignerState()
      Returns:
      The designerState structure of the deeply selected component.

    • updateDesignerState

      void updateDesignerState(com.inductiveautomation.ignition.common.gson.JsonElement write)
      Calls updateDesignerState with the given object. The values in the object will be merged in with the existing

    • writeToProps

      void writeToProps(String path, com.inductiveautomation.ignition.common.gson.JsonElement write)