Package com.inductiveautomation.perspective.common.config.styles

Class StyleClassConfig

java.lang.Object

com.inductiveautomation.perspective.common.config.styles.StyleClassConfig

public class StyleClassConfig
extends java.lang.Object

Represents a style class's stored configuration. This class is meant to be used by GSON for json serialization and deserialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StyleClassConfig.GsonAdapter

Field Summary

Fields

Modifier and Type	Field	Description
StyleVariantConfig	base
static java.lang.String	FILENAME
static ResourceType	RESOURCE_TYPE
static java.util.UUID	ROOT_FOLDER
static JsonSchema	SCHEMA
static java.util.regex.Pattern	VALID_NAME_PATTERN	Restrictive naming pattern for a CSS identifier - starts with letter or underscore, and contains only letters, numbers, underscores, and hyphens
java.util.List<StyleVariantConfig>	variants

Constructor Summary

Constructors

Constructor	Description
StyleClassConfig(StyleClassConfig copy)
StyleClassConfig(StyleVariantConfig base)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static StyleClassConfig	fromProjectResource(ProjectResource resource, com.inductiveautomation.ignition.common.gson.Gson gson)
static java.lang.String	getEscapedName(ProjectResource resource)	Get the name and path to a style, escaped for use in a compiled .css file
static java.lang.String	getRawName(ProjectResource resource)	Get the name and path to a style, directly (suitable for use on actual component style classes)
java.lang.String	toCss(java.lang.String className)

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA

public static final JsonSchema SCHEMA

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

FILENAME

public static final java.lang.String FILENAME

See Also:

Constant Field Values

ROOT_FOLDER

public static final java.util.UUID ROOT_FOLDER

VALID_NAME_PATTERN

public static final java.util.regex.Pattern VALID_NAME_PATTERN

Restrictive naming pattern for a CSS identifier - starts with letter or underscore, and contains only letters, numbers, underscores, and hyphens

base

public StyleVariantConfig base

variants

public final java.util.List<StyleVariantConfig> variants

Constructor Detail

StyleClassConfig

public StyleClassConfig(StyleVariantConfig base)

StyleClassConfig

public StyleClassConfig(StyleClassConfig copy)

Method Detail

fromProjectResource

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

getEscapedName

public static java.lang.String getEscapedName(@Nonnull
                                              ProjectResource resource)

Get the name and path to a style, escaped for use in a compiled .css file

getRawName

public static java.lang.String getRawName(@Nonnull
                                          ProjectResource resource)

Get the name and path to a style, directly (suitable for use on actual component style classes)

toCss

public java.lang.String toCss(java.lang.String className)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object