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

Class ReactEditForm

java.lang.Object

com.inductiveautomation.ignition.gateway.web.pages.config.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: { ... } }

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 and Description
ReactEditForm()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	getAdvancedCategories(com.google.gson.JsonObject form)
static java.util.List<java.lang.String>	getCategories(com.google.gson.JsonObject form)
static com.google.gson.JsonObject	merge(com.google.gson.JsonObject form1, com.google.gson.JsonObject form2) Merge form 2 into form 1.
static ReactEditForm.Builder	newBuilder()
static com.google.gson.JsonObject	put(com.google.gson.JsonObject form, java.lang.String category, java.util.List<com.google.gson.JsonObject> fields)
static com.google.gson.JsonObject	putAdvanced(com.google.gson.JsonObject form, java.lang.String category, java.util.List<com.google.gson.JsonObject> fields)
static com.google.gson.JsonObject	remove(com.google.gson.JsonObject form, java.lang.String category)
static com.google.gson.JsonObject	remove(com.google.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

KEYS

public static final java.lang.String KEYS

See Also:

Constant Field Values

STANDARD

public static final java.lang.String STANDARD

See Also:

Constant Field Values

ADVANCED

public static final java.lang.String ADVANCED

See Also:

Constant Field Values

CATEGORY_TYPES

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

Constructor Detail

ReactEditForm

public ReactEditForm()

Method Detail

newBuilder

public static ReactEditForm.Builder newBuilder()

put

public static com.google.gson.JsonObject put(com.google.gson.JsonObject form,
                                             java.lang.String category,
                                             java.util.List<com.google.gson.JsonObject> fields)

putAdvanced

public static com.google.gson.JsonObject putAdvanced(com.google.gson.JsonObject form,
                                                     java.lang.String category,
                                                     java.util.List<com.google.gson.JsonObject> fields)

remove

public static com.google.gson.JsonObject remove(com.google.gson.JsonObject form,
                                                java.lang.String category)

getCategories

public static java.util.List<java.lang.String> getCategories(com.google.gson.JsonObject form)

getAdvancedCategories

public static java.util.List<java.lang.String> getAdvancedCategories(com.google.gson.JsonObject form)

merge

public static com.google.gson.JsonObject merge(com.google.gson.JsonObject form1,
                                               com.google.gson.JsonObject form2)

Merge form 2 into form 1. Modifies the argument

remove

public static com.google.gson.JsonObject remove(com.google.gson.JsonObject form,
                                                java.lang.String category,
                                                java.util.List<java.lang.String> fieldIds)