Package com.inductiveautomation.ignition.alarming.designer.prototypes

Class SwitchBlockPrototype

java.lang.Object

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

com.inductiveautomation.ignition.alarming.designer.prototypes.SwitchBlockPrototype

All Implemented Interfaces:

PipelineBlockPrototype

public class SwitchBlockPrototype
extends AbstractBlockPrototype

Field Summary

Fields inherited from class com.inductiveautomation.ignition.alarming.designer.api.AbstractBlockPrototype

blockTitle, COMMON_OUTPUT_DESCRIPTOR, factoryId

Constructor Summary

Constructors

Constructor	Description
SwitchBlockPrototype()

Method Summary

Modifier and Type	Method	Description
javax.swing.JComponent	createEditingUI(DesignerContext context, PropertySet block)	Create a new editing UI for the given block.
ObservablePropertySet	createNewBlock()	Creates a new BasicPropertySet, setting the CommonBlockProperties.FACTORY_ID on it.
java.util.Collection<Property<?>>	getBlockMutatingProperties()	Which properties (if any) are able to alter the structure of the block (number/names of outputs)
javax.swing.Icon	getIcon()
java.util.List<OutputDescriptor>	getOutputs(ObservablePropertySet block)
javax.swing.Icon	getSmallIcon()
void	initPreviewPanel(ObservablePropertySet block, javax.swing.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.

Methods inherited from class com.inductiveautomation.ignition.alarming.designer.api.AbstractBlockPrototype

getFactoryId, getRolloverIcon, getSearchableProperties, getTitle, isSystemOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchBlockPrototype

public SwitchBlockPrototype()

Method Detail

getIcon

public javax.swing.Icon getIcon()

Specified by:

getIcon in interface PipelineBlockPrototype

Overrides:

getIcon in class AbstractBlockPrototype

Returns:

A 32x32 icon for the palette

getSmallIcon

public javax.swing.Icon getSmallIcon()

Specified by:

getSmallIcon in interface PipelineBlockPrototype

Overrides:

getSmallIcon in class AbstractBlockPrototype

Returns:

Small 16x16 icon for the title of the block

createNewBlock

public ObservablePropertySet createNewBlock()

Description copied from class: AbstractBlockPrototype

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

Specified by:

createNewBlock in interface PipelineBlockPrototype

Overrides:

createNewBlock in class AbstractBlockPrototype

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

Overrides:

isPreviewPanelSupported in class AbstractBlockPrototype

initPreviewPanel

public void initPreviewPanel(ObservablePropertySet block,
                             javax.swing.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

Overrides:

initPreviewPanel in class AbstractBlockPrototype

getOutputs

public java.util.List<OutputDescriptor> getOutputs(ObservablePropertySet block)

Specified by:

getOutputs in interface PipelineBlockPrototype

Overrides:

getOutputs in class AbstractBlockPrototype

getBlockMutatingProperties

public java.util.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

Overrides:

getBlockMutatingProperties in class AbstractBlockPrototype

createEditingUI

public javax.swing.JComponent createEditingUI(DesignerContext context,
                                              PropertySet block)

Description copied from interface: PipelineBlockPrototype

Create a new editing UI for the given block. Note that your component may implement PipelineBlockEditor to get callbacks on uninstall