Class ReactEditForm


  • public class ReactEditForm
    extends java.lang.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: { ... } }

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ADVANCED  
      static java.util.List<java.lang.String> CATEGORY_TYPES  
      static java.lang.String KEYS  
      static java.lang.String STANDARD  
    • Constructor Summary

      Constructors 
      Constructor Description
      ReactEditForm()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<java.lang.String> getAdvancedCategories​(com.inductiveautomation.ignition.common.gson.JsonObject form)  
      static java.util.List<java.lang.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, java.lang.String category, java.util.List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)  
      static com.inductiveautomation.ignition.common.gson.JsonObject putAdvanced​(com.inductiveautomation.ignition.common.gson.JsonObject form, java.lang.String category, java.util.List<com.inductiveautomation.ignition.common.gson.JsonObject> fields)  
      static com.inductiveautomation.ignition.common.gson.JsonObject remove​(com.inductiveautomation.ignition.common.gson.JsonObject form, java.lang.String category)  
      static com.inductiveautomation.ignition.common.gson.JsonObject remove​(com.inductiveautomation.ignition.common.gson.JsonObject form, java.lang.String category, java.util.List<java.lang.String> fieldIds)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CATEGORY_TYPES

        public static final java.util.List<java.lang.String> CATEGORY_TYPES
    • Constructor Detail

      • ReactEditForm

        public ReactEditForm()
    • Method Detail

      • put

        public static com.inductiveautomation.ignition.common.gson.JsonObject put​(com.inductiveautomation.ignition.common.gson.JsonObject form,
                                                                                  java.lang.String category,
                                                                                  java.util.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,
                                                                                          java.lang.String category,
                                                                                          java.util.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,
                                                                                     java.lang.String category)
      • getCategories

        public static java.util.List<java.lang.String> getCategories​(com.inductiveautomation.ignition.common.gson.JsonObject form)
      • getAdvancedCategories

        public static java.util.List<java.lang.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,
                                                                                     java.lang.String category,
                                                                                     java.util.List<java.lang.String> fieldIds)