Class ClientStepRegistry
- java.lang.Object
-
- com.inductiveautomation.ignition.common.util.AbstractChangeable
-
- com.inductiveautomation.sfc.client.api.ClientStepRegistry
-
- All Implemented Interfaces:
Changeable
,StepRegistry
- Direct Known Subclasses:
ClientStepRegistryImpl
public abstract class ClientStepRegistry extends AbstractChangeable implements StepRegistry, Changeable
The ClientStepRegistry is where you need to add your ClientStepFactory to add a step. You can obtain the ClientStepRegistry via
getInstance(ClientContext)
.You'll need to do this in both Client and Desginer hooks. In the Designer, you need to also add a StepConfigFactory as well.
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
changeEvent, listenerList
-
-
Constructor Summary
Constructors Constructor Description ClientStepRegistry()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.util.Collection<ClientStepFactory>
getFactories()
Returns a read-only collection of the registered factoriesstatic ClientStepRegistry
getInstance(ClientContext context)
abstract com.google.common.base.Optional<ClientStepFactory>
getStepFactory(java.lang.String id)
Looks up the delegate for the given step factory id.abstract void
register(ClientStepFactory factory)
-
Methods inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable
addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.common.util.Changeable
addChangeListener, removeChangeListener
-
-
-
-
Method Detail
-
getInstance
public static ClientStepRegistry getInstance(ClientContext context)
-
register
public abstract void register(ClientStepFactory factory)
-
getStepFactory
public abstract com.google.common.base.Optional<ClientStepFactory> getStepFactory(java.lang.String id)
Description copied from interface:StepRegistry
Looks up the delegate for the given step factory id.- Specified by:
getStepFactory
in interfaceStepRegistry
-
getFactories
public abstract java.util.Collection<ClientStepFactory> getFactories()
Returns a read-only collection of the registered factories
-
-