ClientStepFactory

All Superinterfaces:

StepDelegate

All Known Implementing Classes:

ActionStepUI.ActionStepFactory, AssertionStepUI.AssertionStepFactory, BeginStepUI.BeginStepFactory, EnclosingStepUI.EnclosingStepFactory, EndStepUI.EndStepFactory
```
public interface ClientStepFactory
extends StepDelegate
```
A ClientStepFactory is responsible for creating StepView objects given their associated StepConfig objects. To add a new kind of Step, you'll need to implement this interface, and then register it with the ClentStepRegistry in a ClientModuleHook

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	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.
`java.lang.String`	`getId()`	A unique string that identifies this kind of step
`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
`default 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 interface com.inductiveautomation.sfc.api.StepDelegate
fromXml, getCompilationAlteringProperties, toXml, validate

- Method Detail
  - getId
```
java.lang.String getId()
```
    A unique string that identifies this kind of step
    
    Specified by:
    
    getId in interface StepDelegate
    
    Returns:
    
    A unique string that identifies this kind of step, for example: "com.company.foostep".
  - getCategory
```
java.lang.String getCategory()
```
    A string representing the step's category. Will be represented as a tab on the step palette
  - getPaletteIcon
```
javax.swing.Icon getPaletteIcon()
```
    The primary icon (32x32) for the palette
  - getRolloverPaletteIcon
```
default javax.swing.Icon getRolloverPaletteIcon()
```
    A 'highlighted' version of the primary icon
  - getPaletteText
```
java.lang.String getPaletteText()
```
    A short name for the step to be displayed beneath its palette item
  - getPaletteTooltip
```
java.lang.String getPaletteTooltip()
```
    A short description of what the step does
  - initializeStep
```
void initializeStep(ChartUIElement element)
```
    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.
  - createStepUI
```
StepUI createStepUI(ChartUIElement element)
```
    Create the UI component that is used to represent this step.
    
    Parameters:
    
    element - The chart element that represents this step