Class AbstractEnclosingStepDelegate
- java.lang.Object
-
- com.inductiveautomation.sfc.elements.steps.enclosing.AbstractEnclosingStepDelegate
-
- All Implemented Interfaces:
StepDelegate
,ChartStepProperties
,EnclosingStepProperties
- Direct Known Subclasses:
EnclosingStepUI.EnclosingStepFactory
public abstract class AbstractEnclosingStepDelegate extends java.lang.Object implements StepDelegate, EnclosingStepProperties
-
-
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 AbstractEnclosingStepDelegate()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
fromXml(org.w3c.dom.Element domElement, ChartUIElement uiElement)
Given an XML DOM element, fill in the properties of theChartUIElement
.java.util.List<Property<?>>
getCompilationAlteringProperties()
java.lang.String
getId()
static boolean
isEnclosingStep(ChartUIElement element)
void
toXml(javax.xml.stream.XMLStreamWriter writer, ChartUIElement element, java.lang.String tab)
Serialize the given element (which is guaranteed to be a step element of this factory's type) to the stream writer.void
validate(ChartUIElement element, ChartCompilationResults results)
Provides step implementations a chance to validate their settings.
-
-
-
Method Detail
-
getId
public java.lang.String getId()
- Specified by:
getId
in interfaceStepDelegate
- Returns:
- A unique string that identifies this kind of step, for example: "com.company.foostep".
-
toXml
public void toXml(javax.xml.stream.XMLStreamWriter writer, ChartUIElement element, java.lang.String tab) throws javax.xml.stream.XMLStreamException
Description copied from interface:StepDelegate
Serialize the given element (which is guaranteed to be a step element of this factory's type) to the stream writer. Common step attributes (type, id, name, size, location) will have already been serialized, meaning, the xml stream will have just written the open <step> element. Close any elements you open.- Specified by:
toXml
in interfaceStepDelegate
- Parameters:
writer
- theXMLStreamWriter
to write to.element
- theChartUIElement
to serialize.- Throws:
javax.xml.stream.XMLStreamException
-
fromXml
public void fromXml(org.w3c.dom.Element domElement, ChartUIElement uiElement) throws XmlParseException
Description copied from interface:StepDelegate
Given an XML DOM element, fill in the properties of theChartUIElement
. Just like for serializing, the id, location, and name will have already been handled.- Specified by:
fromXml
in interfaceStepDelegate
- Parameters:
domElement
- the XML DOM element.uiElement
- theChartUIElement
to deserialize.- Throws:
XmlParseException
-
validate
public void validate(ChartUIElement element, ChartCompilationResults results)
Description copied from interface:StepDelegate
Provides step implementations a chance to validate their settings. If the settings are invalid, they should add an error to the compilation results.- Specified by:
validate
in interfaceStepDelegate
- Parameters:
element
- theChartUIElement
to validate.results
- theChartCompilationResults
.
-
getCompilationAlteringProperties
public java.util.List<Property<?>> getCompilationAlteringProperties()
- Specified by:
getCompilationAlteringProperties
in interfaceStepDelegate
- Returns:
- a list of properties that may alter this step's compilation validation.
-
isEnclosingStep
public static boolean isEnclosingStep(ChartUIElement element)
-
-