Package com.inductiveautomation.perspective.common.api

Class ComponentRegistry

java.lang.Object

com.inductiveautomation.perspective.common.api.ComponentRegistry

Direct Known Subclasses:

DesignerComponentRegistry

public class ComponentRegistry
extends Object

Registry of all perspective components. Module authors should register their components here in both Gateway and Designer scopes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentRegistry.ComponentRegistryListener

Constructor Summary

Constructors

Constructor	Description
ComponentRegistry()
ComponentRegistry(List<String> defFileNames)

Method Summary

Modifier and Type	Method	Description
protected ComponentDescriptor	buildDescriptor(com.inductiveautomation.ignition.common.gson.JsonObject componentDef, String versionHash)
static BufferedImage	fetchImage(URL url)	Fetches an image will be used for component palette tile entries in the designer.
Optional<ComponentDescriptor>	find(String type)
Map<String,ComponentDescriptor>	get()
Set<String>	getCategories()
void	registerComponent(ComponentDescriptor comp)	Registers a component with the Perspective ComponentRegistry.
void	registerListener(ComponentRegistry.ComponentRegistryListener listener)
void	removeComponent(String componentId)	Removes a component from the registry.
void	removeListener(ComponentRegistry.ComponentRegistryListener listener)

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentRegistry

public ComponentRegistry()

ComponentRegistry

public ComponentRegistry(List<String> defFileNames)

Method Details

registerComponent

public void registerComponent(@Nonnull
 ComponentDescriptor comp)

Registers a component with the Perspective ComponentRegistry.

For a component to show up, it must

1. Not be deprecated
2. Have at least one palette varient
3. Have a valid name
4. Include any appropriate BrowserResource entries

Registering a new component will notify any registered ComponentRegistry.ComponentRegistryListeners.

Parameters:

comp - the descriptor for the component

removeComponent

public void removeComponent(@Nonnull
 String componentId)

Removes a component from the registry.

Removing a component will notify any registered ComponentRegistry.ComponentRegistryListeners.

Parameters:

componentId - the ComponentDescriptor.id() value of the component to remove

get

public Map<String,ComponentDescriptor> get()

find

public Optional<ComponentDescriptor> find(String type)

getCategories

public Set<String> getCategories()

buildDescriptor

protected ComponentDescriptor buildDescriptor(com.inductiveautomation.ignition.common.gson.JsonObject componentDef,
 @Nullable
 String versionHash)

registerListener

public void registerListener(ComponentRegistry.ComponentRegistryListener listener)

removeListener

public void removeListener(ComponentRegistry.ComponentRegistryListener listener)

fetchImage

@Nullable
public static BufferedImage fetchImage(URL url)

Fetches an image will be used for component palette tile entries in the designer. The image will be scaled down to 72x48.

Parameters:

url - URL for the image

Returns:

a buffered image or null if the URL is not valid