Class ShepherdEngine

java.lang.Object

org.vaadin.addons.antlerflow.tour.engine.ShepherdEngine

All Implemented Interfaces:

TourEngine

@JsModule("./antlerflow/tour/engines/bridge.ts")
@NpmPackage(value="shepherd.js",
            version="13.0.3")
public class ShepherdEngine
extends Object
implements TourEngine

Implementation of the TourEngine interface using the "shepherd.js" library as the underlying engine for guided tours.

This class facilitates the integration of the "shepherd" tour engine into a Vaadin application, enabling developers to create guided tours with the methods defined by the TourEngine interface.

The engine is identified by its unique identifier "shepherd", which is specified in the getId method. The identifier is used to distinguish this engine from others, such as "driver", for applications that utilize multiple engine types.

Dependencies:
- shepherd.js: Version 13.0.3, included as an NPM package.
- bridge.ts: JavaScript bridge module for enabling communication between server-side
  and client-side components.

Notes:
- This class relies on the EngineType.SHEPHERD enumeration value to retrieve the unique
  engine identifier.
- The getId method is used internally by the framework to ensure that the appropriate
  engine is selected and activated for guided tours.

Field Summary

Fields inherited from interface TourEngine

GSON

Constructor Summary

Constructors

Constructor	Description
ShepherdEngine()

Method Summary

Modifier and Type	Method	Description
String	getId()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface TourEngine

cancel, start, wireEvents

Constructor Details

ShepherdEngine

public ShepherdEngine()

Method Details

getId

public String getId()

Specified by:

getId in interface TourEngine