Package com.inductiveautomation.sfc.client.api

Interface 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 Details

    • getId

      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

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

    • getPaletteIcon

      Icon getPaletteIcon()
      The primary icon (32x32) for the palette

    • getRolloverPaletteIcon

      default Icon getRolloverPaletteIcon()
      A 'highlighted' version of the primary icon

    • getPaletteText

      String getPaletteText()
      A short name for the step to be displayed beneath its palette item

    • getPaletteTooltip

      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