Package com.inductiveautomation.ignition.alarming.designer.api

Class AbstractBlockPrototype

java.lang.Object

com.inductiveautomation.ignition.alarming.designer.api.AbstractBlockPrototype

All Implemented Interfaces:

PipelineBlockPrototype

Direct Known Subclasses:

DelayBlockPrototype, EventStreamBlockPrototype, ExpressionBlockPrototype, JumpBlockPrototype, LegacyNotificationPrototype, NotificationBlockPrototype, PropertySetterBlockPrototype, ScriptableBlockPrototype, SplitterBlockPrototype, SwitchBlockPrototype

public abstract class AbstractBlockPrototype
extends Object
implements PipelineBlockPrototype

Base class for most block prototype implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected LocalizedString	blockTitle
static final OutputDescriptor	COMMON_OUTPUT_DESCRIPTOR	An output descriptor to use for most blocks with a single output.
protected String	factoryId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBlockPrototype(String factoryId, String titleKey)

Method Summary

Modifier and Type	Method	Description
ObservablePropertySet	createNewBlock()	Creates a new BasicPropertySet, setting the CommonBlockProperties.FACTORY_ID on it.
Collection<Property<?>>	getBlockMutatingProperties()	Which properties (if any) are able to alter the structure of the block (number/names of outputs)
String	getFactoryId()	Return the factory id of blocks created with this prototype.
Icon	getIcon()
List<OutputDescriptor>	getOutputs(ObservablePropertySet block)
Icon	getRolloverIcon()
Collection<Property<?>>	getSearchableProperties(PropertySet block)	Which properties (if any) are eligible for the search and replace system.
Icon	getSmallIcon()
LocalizedString	getTitle()
void	initPreviewPanel(ObservablePropertySet block, JPanel panel)	Used to initialize a small preview of the block's properties, which is displayed beneath the block.
boolean	isPreviewPanelSupported()	Return true here if you want to add extra information to the block display on a preview panel beneath the input/output pins.
boolean	isSystemOnly()	Returns whether only the system can programmatically create these types of blocks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.alarming.designer.api.PipelineBlockPrototype

createEditingUI

Field Details

COMMON_OUTPUT_DESCRIPTOR

public static final OutputDescriptor COMMON_OUTPUT_DESCRIPTOR

An output descriptor to use for most blocks with a single output. Uses CommonBlockProperties.OUTPUT_ID for the output property.

blockTitle

protected LocalizedString blockTitle

factoryId

protected String factoryId

Constructor Details

AbstractBlockPrototype

protected AbstractBlockPrototype(String factoryId,
 String titleKey)

Parameters:

factoryId - The ID of the factory in the gateway who is in charge of creating working instances of this block type.

titleKey - The title for this block

Method Details

createNewBlock

public ObservablePropertySet createNewBlock()

Creates a new BasicPropertySet, setting the CommonBlockProperties.FACTORY_ID on it.

Specified by:

createNewBlock in interface PipelineBlockPrototype

getTitle

public LocalizedString getTitle()

Specified by:

getTitle in interface PipelineBlockPrototype

Returns:

the title for the block

getIcon

public Icon getIcon()

Specified by:

getIcon in interface PipelineBlockPrototype

Returns:

A 32x32 icon for the palette

getRolloverIcon

public Icon getRolloverIcon()

Specified by:

getRolloverIcon in interface PipelineBlockPrototype

Returns:

Rollover version of the palette icon.

getSmallIcon

public Icon getSmallIcon()

Specified by:

getSmallIcon in interface PipelineBlockPrototype

Returns:

Small 16x16 icon for the title of the block

getFactoryId

public String getFactoryId()

Description copied from interface: PipelineBlockPrototype

Return the factory id of blocks created with this prototype.

Specified by:

getFactoryId in interface PipelineBlockPrototype

getOutputs

public List<OutputDescriptor> getOutputs(ObservablePropertySet block)

Specified by:

getOutputs in interface PipelineBlockPrototype

getBlockMutatingProperties

public Collection<Property<?>> getBlockMutatingProperties()

Description copied from interface: PipelineBlockPrototype

Which properties (if any) are able to alter the structure of the block (number/names of outputs)

Specified by:

getBlockMutatingProperties in interface PipelineBlockPrototype

getSearchableProperties

public Collection<Property<?>> getSearchableProperties(PropertySet block)

Description copied from interface: PipelineBlockPrototype

Which properties (if any) are eligible for the search and replace system.

Specified by:

getSearchableProperties in interface PipelineBlockPrototype

Parameters:

block - The block in question

isPreviewPanelSupported

public boolean isPreviewPanelSupported()

Description copied from interface: PipelineBlockPrototype

Return true here if you want to add extra information to the block display on a preview panel beneath the input/output pins.

Specified by:

isPreviewPanelSupported in interface PipelineBlockPrototype

initPreviewPanel

public void initPreviewPanel(ObservablePropertySet block,
 JPanel panel)

Description copied from interface: PipelineBlockPrototype

Used to initialize a small preview of the block's properties, which is displayed beneath the block.

Specified by:

initPreviewPanel in interface PipelineBlockPrototype

isSystemOnly

public boolean isSystemOnly()

Description copied from interface: PipelineBlockPrototype

Returns whether only the system can programmatically create these types of blocks. If false, the user will be able to create them from the palette.

Specified by:

isSystemOnly in interface PipelineBlockPrototype