Package com.inductiveautomation.perspective.gateway.assets.themes

Class ThemeManagerImpl

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.ignition.gateway.config.NamedResourceHandler<ThemeConfig>

com.inductiveautomation.perspective.gateway.assets.themes.ThemeManagerImpl

All Implemented Interfaces:

Lifecycle, ThemeManager

public class ThemeManagerImpl
extends NamedResourceHandler<ThemeConfig>
implements ThemeManager

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

NamedResourceHandler.Builder<R>

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	RESOURCE_TYPE
static final ResourceTypeMeta<ThemeConfig>	RESOURCE_TYPE_META

Fields inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

configManager, logger, meta

Constructor Summary

Constructors

Constructor	Description
ThemeManagerImpl(PerspectiveContext perspectiveContext)

Method Summary

Modifier and Type	Method	Description
void	copyReservedThemesToCore()
Optional<String>	getTheme(String themeName)	Delivers a processed theme file.
List<String>	getThemesList()	Fetch a list of all of the available theme names.
void	migrate()
protected void	onInitialResources(List<DecodedResource<ThemeConfig>> decodedResources)	Called once at startup with the resource that are already present in the configuration collection.
protected void	onResourceAdded(DecodedResource<ThemeConfig> res)	Called once per each resource that is added.
protected void	onResourceRemoved(DecodedResource<ThemeConfig> res)	Called for resources that are removed (or updated and then fail to parse).
protected void	onResourcesUpdated(List<DecodedResource<ThemeConfig>> decodedResources)	Called each time the overall set of resources changes in any way.
protected void	onResourceUpdated(ModifiedResource<ThemeConfig> res)	Called once per each resource that is updated.
void	setup()

Methods inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

create, create, create, decode, delete, delete, filter, findResource, getResources, isCaseSensitive, isRenameAware, modify, modify, modify, newBuilder, newUuid, onShutdown, onStartup, renameAndModify, renameAndModify, renameAndModify, renameAndModify

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

RESOURCE_TYPE_META

public static final ResourceTypeMeta<ThemeConfig> RESOURCE_TYPE_META

Constructor Details

ThemeManagerImpl

public ThemeManagerImpl(@Nonnull
 PerspectiveContext perspectiveContext)

Method Details

migrate

public void migrate()
             throws MigrationException

Throws:

MigrationException

setup

public void setup()

copyReservedThemesToCore

public void copyReservedThemesToCore()
                              throws PushException

Throws:

PushException

onInitialResources

protected void onInitialResources(List<DecodedResource<ThemeConfig>> decodedResources)

Description copied from class: NamedResourceHandler

Called once at startup with the resource that are already present in the configuration collection.

Overrides:

onInitialResources in class NamedResourceHandler<ThemeConfig>

onResourceAdded

protected void onResourceAdded(DecodedResource<ThemeConfig> res)

Description copied from class: NamedResourceHandler

Called once per each resource that is added.

Overrides:

onResourceAdded in class NamedResourceHandler<ThemeConfig>

onResourceUpdated

protected void onResourceUpdated(ModifiedResource<ThemeConfig> res)

Description copied from class: NamedResourceHandler

Called once per each resource that is updated.

Note that whether "rename" events are considered "updates" or "removes" and "adds" is determined by NamedResourceHandler.isRenameAware().

Overrides:

onResourceUpdated in class NamedResourceHandler<ThemeConfig>

onResourceRemoved

protected void onResourceRemoved(DecodedResource<ThemeConfig> res)

Description copied from class: NamedResourceHandler

Called for resources that are removed (or updated and then fail to parse).

Overrides:

onResourceRemoved in class NamedResourceHandler<ThemeConfig>

onResourcesUpdated

protected void onResourcesUpdated(List<DecodedResource<ThemeConfig>> decodedResources)

Description copied from class: NamedResourceHandler

Called each time the overall set of resources changes in any way. Called after added, updated, and removed are called.

Overrides:

onResourcesUpdated in class NamedResourceHandler<ThemeConfig>

getTheme

public Optional<String> getTheme(String themeName)

Delivers a processed theme file. The CSS is computed and cached via the config system notifying changes to the resources and cached, the response from here is the cached computed theme.

Specified by:

getTheme in interface ThemeManager

Parameters:

themeName - - The base name, i.e., theme-dark, of the theme to fetch. Assumes that the theme does not contain the CSS file extension.

Returns:

- Returns an optional string representing the requested theme as CSS.

getThemesList

public List<String> getThemesList()

Description copied from interface: ThemeManager

Fetch a list of all of the available theme names.

Specified by:

getThemesList in interface ThemeManager

Returns:

A string list of available themes that may be fetched using ThemeManager.getTheme(String themeName).