Package com.inductiveautomation.ignition.gateway.web.pages.config

Class ReactEditForm

java.lang.Object
com.inductiveautomation.ignition.gateway.web.pages.config.ReactEditForm
public class ReactEditForm extends Object
Used to build a json object representing a config section form, used in the React front end.

Representation:

{ standard: { categoryKeys: [...],

[categoryKey]: [ { //field id, name, type, value, description, //optional default //optional }, ... ],

[categoryKey]: [ ... ], ... },

advanced: { ... } }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ReactEditForm.Builder
     
    static class 
    ReactEditForm.Field
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ADVANCED
     
    static final List<String>
    CATEGORY_TYPES
     
    static final String
    KEYS
     
    static final String
    STANDARD
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReactEditForm()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<String>
    getAdvancedCategories(com.inductiveautomation.ignition.common.gson.JsonObject form)
     
    static List<String>
    getCategories(com.inductiveautomation.ignition.common.gson.JsonObject form)
     
    static com.inductiveautomation.ignition.common.gson.JsonObject
    merge(com.inductiveautomation.ignition.common.gson.JsonObject form1, com.inductiveautomation.ignition.common.gson.JsonObject form2)
    Merge form 2 into form 1.
    static ReactEditForm.Builder
    newBuilder()
     
    static com.inductiveautomation.ignition.common.gson.JsonObject
    put(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)
     
    static com.inductiveautomation.ignition.common.gson.JsonObject
    putAdvanced(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)
     
    static com.inductiveautomation.ignition.common.gson.JsonObject
    remove(com.inductiveautomation.ignition.common.gson.JsonObject form, String category)
     
    static com.inductiveautomation.ignition.common.gson.JsonObject
    remove(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<String> fieldIds)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ReactEditForm

      public ReactEditForm()

  • Method Details

    • newBuilder

      public static ReactEditForm.Builder newBuilder()

    • put

      public static com.inductiveautomation.ignition.common.gson.JsonObject put(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)

    • putAdvanced

      public static com.inductiveautomation.ignition.common.gson.JsonObject putAdvanced(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)

    • remove

      public static com.inductiveautomation.ignition.common.gson.JsonObject remove(com.inductiveautomation.ignition.common.gson.JsonObject form, String category)

    • getCategories

      public static List<String> getCategories(com.inductiveautomation.ignition.common.gson.JsonObject form)

    • getAdvancedCategories

      public static List<String> getAdvancedCategories(com.inductiveautomation.ignition.common.gson.JsonObject form)

    • merge

      public static com.inductiveautomation.ignition.common.gson.JsonObject merge(com.inductiveautomation.ignition.common.gson.JsonObject form1, com.inductiveautomation.ignition.common.gson.JsonObject form2)
      Merge form 2 into form 1. Modifies the argument

    • remove

      public static com.inductiveautomation.ignition.common.gson.JsonObject remove(com.inductiveautomation.ignition.common.gson.JsonObject form, String category, List<String> fieldIds)