Package com.inductiveautomation.sfc.client.ui

Class BeginStepUI.BeginStepFactory

java.lang.Object

com.inductiveautomation.sfc.elements.steps.begin.AbstractBeginStepDelegate

com.inductiveautomation.sfc.client.ui.BeginStepUI.BeginStepFactory

All Implemented Interfaces:

StepDelegate, ClientStepFactory, BeginStepProperties, ChartStepProperties

Enclosing class:

BeginStepUI

public static final class BeginStepUI.BeginStepFactory
extends AbstractBeginStepDelegate
implements ClientStepFactory

Field Summary

Fields inherited from interface com.inductiveautomation.sfc.elements.steps.begin.BeginStepProperties

FACTORY_ID, INPUTS

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

AssociatedData, Breakpoint, FactoryId, Name

Constructor Summary

Constructors

Constructor	Description
BeginStepFactory()

Method Summary

Modifier and Type	Method	Description
StepUI	createStepUI(ChartUIElement element)	Create the UI component that is used to represent this step.
String	getCategory()	A string representing the step's category.
Icon	getPaletteIcon()	The primary icon (32x32) for the palette
String	getPaletteText()	A short name for the step to be displayed beneath its palette item
String	getPaletteTooltip()	A short description of what the step does
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.begin.AbstractBeginStepDelegate

fromXml, getCompilationAlteringProperties, getId, 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 Details

BeginStepFactory

public BeginStepFactory()

Method Details

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 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 Icon getPaletteIcon()

Description copied from interface: ClientStepFactory

The primary icon (32x32) for the palette

Specified by:

getPaletteIcon in interface ClientStepFactory

getRolloverPaletteIcon

public Icon getRolloverPaletteIcon()

Description copied from interface: ClientStepFactory

A 'highlighted' version of the primary icon

Specified by:

getRolloverPaletteIcon in interface ClientStepFactory

getPaletteText

public 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 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