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.ChartStepProperties
AssociatedData, Breakpoint, FactoryId, Name
-
Fields inherited from interface com.inductiveautomation.sfc.elements.steps.enclosing.EnclosingStepProperties
CHART_PATH, EXECUTION_MODE, FACTORY_ID, PASSED_PARAMS, RETURN_PARAMS
-
-
Constructor Summary
Constructors Constructor Description EnclosingStepFactory()
-
Method Summary
All Methods Instance Methods Concrete 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.javax.swing.Icon
getPaletteIcon()
The primary icon (32x32) for the palettejava.lang.String
getPaletteText()
A short name for the step to be displayed beneath its palette itemjava.lang.String
getPaletteTooltip()
A short description of what the step doesjavax.swing.Icon
getRolloverPaletteIcon()
A 'highlighted' version of the primary iconvoid
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
-
-
-
-
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 interfaceClientStepFactory
- 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 interfaceClientStepFactory
-
getPaletteIcon
public javax.swing.Icon getPaletteIcon()
Description copied from interface:ClientStepFactory
The primary icon (32x32) for the palette- Specified by:
getPaletteIcon
in interfaceClientStepFactory
-
getRolloverPaletteIcon
public javax.swing.Icon getRolloverPaletteIcon()
Description copied from interface:ClientStepFactory
A 'highlighted' version of the primary icon- Specified by:
getRolloverPaletteIcon
in interfaceClientStepFactory
-
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 interfaceClientStepFactory
-
getPaletteTooltip
public java.lang.String getPaletteTooltip()
Description copied from interface:ClientStepFactory
A short description of what the step does- Specified by:
getPaletteTooltip
in interfaceClientStepFactory
-
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 interfaceClientStepFactory
-
-