Class ViewConfig
- java.lang.Object
-
- com.inductiveautomation.perspective.common.config.ViewConfig
-
public class ViewConfig extends java.lang.Object
Config object for a single view definition.
This object is designed to be serialized to JSON format using gson. This JSON document is what is stored inside the project resource record for this view.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ViewConfig.RuntimeGsonAdapter
static class
ViewConfig.StandardGsonAdapter
-
Field Summary
Fields Modifier and Type Field Description com.inductiveautomation.ignition.common.gson.JsonObject
custom
Collection of custom (internal) properties defined on this viewEventConfig
events
Configs for event/action handlingcom.inductiveautomation.ignition.common.gson.JsonObject
params
Collection of properties that hold the default values for the parametersPermissionsConfig
permissions
Permissions config for allowing access to the viewPropertyConfigCollection
propConfig
The configs for individual propertiescom.inductiveautomation.ignition.common.gson.JsonObject
props
The props of the view itself (like the default size)static java.lang.String
RESOURCE_FILENAME
static ResourceType
RESOURCE_TYPE
ComponentConfig
root
The root container of the view.
-
Constructor Summary
Constructors Constructor Description ViewConfig()
ViewConfig(ComponentConfig root)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
static ViewConfig
fromProjectResource(ProjectResource resource, com.inductiveautomation.ignition.common.gson.Gson gson)
java.util.stream.Stream<org.apache.commons.lang3.tuple.Pair<java.lang.String,ParamType>>
getParamDefinitions()
java.util.Optional<PermissionsConfig>
getPermissions()
int
hashCode()
java.lang.String
toString()
-
-
-
Field Detail
-
RESOURCE_TYPE
public static final ResourceType RESOURCE_TYPE
-
RESOURCE_FILENAME
public static final java.lang.String RESOURCE_FILENAME
- See Also:
- Constant Field Values
-
root
public ComponentConfig root
The root container of the view.
-
props
public com.inductiveautomation.ignition.common.gson.JsonObject props
The props of the view itself (like the default size)
-
custom
public com.inductiveautomation.ignition.common.gson.JsonObject custom
Collection of custom (internal) properties defined on this view
-
params
public com.inductiveautomation.ignition.common.gson.JsonObject params
Collection of properties that hold the default values for the parameters
-
propConfig
public PropertyConfigCollection propConfig
The configs for individual properties
-
events
public EventConfig events
Configs for event/action handling
-
permissions
public PermissionsConfig permissions
Permissions config for allowing access to the view
-
-
Constructor Detail
-
ViewConfig
public ViewConfig()
-
ViewConfig
public ViewConfig(ComponentConfig root)
-
-
Method Detail
-
fromProjectResource
public static ViewConfig fromProjectResource(ProjectResource resource, com.inductiveautomation.ignition.common.gson.Gson gson)
-
getParamDefinitions
public java.util.stream.Stream<org.apache.commons.lang3.tuple.Pair<java.lang.String,ParamType>> getParamDefinitions()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getPermissions
@Nonnull public java.util.Optional<PermissionsConfig> getPermissions()
-
-