com.inductiveautomation.ignition.alarming.designer.prototypes

Class NotificationBlockPrototype

java.lang.Object

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

com.inductiveautomation.ignition.alarming.designer.prototypes.NotificationBlockPrototype

All Implemented Interfaces:

NotificationBlockProperties, PipelineBlockPrototype

public class NotificationBlockPrototype
extends AbstractBlockPrototype
implements NotificationBlockProperties

Field Summary

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

blockTitle, COMMON_OUTPUT_DESCRIPTOR, factoryId

Fields inherited from interface com.inductiveautomation.ignition.alarming.common.pipelines.NotificationBlockProperties

BLOCK_VERSION, FACTORY, NOTIFICATION_PROFILE, NOTIFICATION_PROFILES, ON_CALL_ROSTER, PROFILE_KEY_PREFIX, ROSTER_TYPE, THROTTLING_DELAY, THROTTLING_ENABLED, THROTTLING_FREQUENCY, TIME_BETWEEN_NOTIFICATIONS

Constructor Summary

Constructors

Constructor and Description
NotificationBlockPrototype()

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createEditingUI(DesignerContext context, PropertySet block) Create a new editing UI for the given block.
javax.swing.Icon	getIcon()
javax.swing.Icon	getRolloverIcon()
java.util.Collection<Property<?>>	getSearchableProperties(PropertySet block) Which properties (if any) are eligible for the search and replace system.
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

createNewBlock, getBlockMutatingProperties, getFactoryId, getOutputs, getTitle, isSystemOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationBlockPrototype

public NotificationBlockPrototype()

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

getRolloverIcon

public javax.swing.Icon getRolloverIcon()

Specified by:

getRolloverIcon in interface PipelineBlockPrototype

Overrides:

getRolloverIcon in class AbstractBlockPrototype

Returns:

Rollover version of the palette icon.

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

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

Specified by:

createEditingUI in interface PipelineBlockPrototype

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

getSearchableProperties

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

Overrides:

getSearchableProperties in class AbstractBlockPrototype

Parameters:

block - The block in question

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