Package com.inductiveautomation.reporting.designer.api

Class DesignerShapeRegistry

java.lang.Object

com.inductiveautomation.reporting.designer.api.DesignerShapeRegistry

public final class DesignerShapeRegistry
extends Object

Holds the RM shapes that are on the palette. 3rd party modules may add their own shapes here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DesignerShapeRegistry.ShapeDescriptor

Constructor Summary

Constructors

Constructor	Description
DesignerShapeRegistry()

Method Summary

Modifier and Type	Method	Description
static DesignerShapeRegistry	get(DesignerContext context)	This is how you get an instance of the registry.
List<String>	getCategories()
Optional<DesignerShapeRegistry.ShapeDescriptor>	getDescriptor(Class<? extends RMShape> shapeClass)	Return a previously registered descriptor that matches shapeClass, or Optional.empty() if not found.
List<DesignerShapeRegistry.ShapeDescriptor>	getShapes(String category)
void	register(Class<? extends RMShape> shapeClass)

Methods inherited from class java.lang.Object

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

Constructor Details

DesignerShapeRegistry

public DesignerShapeRegistry()

Method Details

get

public static DesignerShapeRegistry get(DesignerContext context)

This is how you get an instance of the registry.

register

public void register(Class<? extends RMShape> shapeClass)

getCategories

public List<String> getCategories()

getShapes

public List<DesignerShapeRegistry.ShapeDescriptor> getShapes(String category)

getDescriptor

public Optional<DesignerShapeRegistry.ShapeDescriptor> getDescriptor(Class<? extends RMShape> shapeClass)

Return a previously registered descriptor that matches shapeClass, or Optional.empty() if not found.