com.inductiveautomation.sfc.client.ui

Class EnclosingStepUI.EnclosingStepFactory

java.lang.Object

com.inductiveautomation.sfc.elements.steps.enclosing.AbstractEnclosingStepDelegate

com.inductiveautomation.sfc.client.ui.EnclosingStepUI.EnclosingStepFactory

All Implemented Interfaces:

StepDelegate, ClientStepFactory, ChartStepProperties, EnclosingStepProperties

Enclosing class:

EnclosingStepUI

public static final class EnclosingStepUI.EnclosingStepFactory
extends AbstractEnclosingStepDelegate
implements ClientStepFactory

Field Summary

Fields inherited from interface com.inductiveautomation.sfc.elements.steps.enclosing.EnclosingStepProperties

CHART_PATH, EXECUTION_MODE, FACTORY_ID, PASSED_PARAMS, RETURN_PARAMS

Fields inherited from interface com.inductiveautomation.sfc.elements.steps.ChartStepProperties

AssociatedData, Breakpoint, FactoryId, Name

Constructor Summary

Constructors

Constructor and Description
EnclosingStepFactory()

Method Summary

Modifier and Type	Method and Description
StepUI	createStepUI(ChartUIElement element) Create the UI component that is used to represent this step.
java.lang.String	getCategory() A string representing the step's category.
javax.swing.Icon	getPaletteIcon() The primary icon (32x32) for the palette
java.lang.String	getPaletteText() A short name for the step to be displayed beneath its palette item
java.lang.String	getPaletteTooltip() A short description of what the step does
javax.swing.Icon	getRolloverPaletteIcon() A 'highlighted' version of the primary icon
void	initializeStep(ChartUIElement element) Called when a new step is created from the palette.

Methods inherited from class com.inductiveautomation.sfc.elements.steps.enclosing.AbstractEnclosingStepDelegate

fromXml, getCompilationAlteringProperties, getId, isEnclosingStep, toXml, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.sfc.client.api.ClientStepFactory

getId

Methods inherited from interface com.inductiveautomation.sfc.api.StepDelegate

fromXml, getCompilationAlteringProperties, toXml, validate

Constructor Detail

EnclosingStepFactory

public EnclosingStepFactory()

Method Detail

createStepUI

public StepUI createStepUI(ChartUIElement element)

Description copied from interface: ClientStepFactory

Create the UI component that is used to represent this step.

Specified by:

createStepUI in interface ClientStepFactory

Parameters:

element - The chart element that represents this step

getCategory

public java.lang.String getCategory()

Description copied from interface: ClientStepFactory

A string representing the step's category. Will be represented as a tab on the step palette

Specified by:

getCategory in interface ClientStepFactory

getPaletteIcon

public javax.swing.Icon getPaletteIcon()

Description copied from interface: ClientStepFactory

The primary icon (32x32) for the palette

Specified by:

getPaletteIcon in interface ClientStepFactory

getRolloverPaletteIcon

public javax.swing.Icon getRolloverPaletteIcon()

Description copied from interface: ClientStepFactory

A 'highlighted' version of the primary icon

Specified by:

getRolloverPaletteIcon in interface ClientStepFactory

getPaletteText

public java.lang.String getPaletteText()

Description copied from interface: ClientStepFactory

A short name for the step to be displayed beneath its palette item

Specified by:

getPaletteText in interface ClientStepFactory

getPaletteTooltip

public java.lang.String getPaletteTooltip()

Description copied from interface: ClientStepFactory

A short description of what the step does

Specified by:

getPaletteTooltip in interface ClientStepFactory

initializeStep

public void initializeStep(ChartUIElement element)

Description copied from interface: ClientStepFactory

Called when a new step is created from the palette. Things like the Id, Type, and factory if will already be set on the new element.

Specified by:

initializeStep in interface ClientStepFactory