Package com.inductiveautomation.perspective.common.config

Class ViewConfig

java.lang.Object

com.inductiveautomation.perspective.common.config.ViewConfig

public class ViewConfig
extends 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 view
EventConfig	events	Configs for event/action handling
com.inductiveautomation.ignition.common.gson.JsonObject	params	Collection of properties that hold the default values for the parameters
PermissionsConfig	permissions	Permissions config for allowing access to the view
PropertyConfigCollection	propConfig	The configs for individual properties
com.inductiveautomation.ignition.common.gson.JsonObject	props	The props of the view itself (like the default size)
static final String	RESOURCE_FILENAME
static final ResourceType	RESOURCE_TYPE
ComponentConfig	root	The root container of the view.

Constructor Summary

Constructors

Constructor	Description
ViewConfig()
ViewConfig(ComponentConfig root)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ViewConfig	fromProjectResource(ProjectResource resource, com.inductiveautomation.ignition.common.gson.Gson gson)
Stream<org.apache.commons.lang3.tuple.Pair<String,ParamType>>	getParamDefinitions()
Optional<PermissionsConfig>	getPermissions()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

RESOURCE_FILENAME

public static final 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

@Nullable
public PropertyConfigCollection propConfig

The configs for individual properties

events

@Nullable
public EventConfig events

Configs for event/action handling

permissions

@Nullable
public PermissionsConfig permissions

Permissions config for allowing access to the view

Constructor Details

ViewConfig

public ViewConfig()

ViewConfig

public ViewConfig(ComponentConfig root)

Method Details

fromProjectResource

public static ViewConfig fromProjectResource(ProjectResource resource,
 com.inductiveautomation.ignition.common.gson.Gson gson)

getParamDefinitions

public Stream<org.apache.commons.lang3.tuple.Pair<String,ParamType>> getParamDefinitions()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPermissions

@Nonnull
public Optional<PermissionsConfig> getPermissions()