Class DriverEngine

java.lang.Object

org.vaadin.addons.antlerflow.tour.engines.DriverEngine

All Implemented Interfaces:

TourEngine

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

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

This class facilitates the integration of the "driver" tour engine into a Vaadin application, allowing developers to easily implement guided tours using the methods defined in the TourEngine interface.

The engine is identified by its unique identifier "driver", which is provided by the overridden getId method. This identifier is used to distinguish this engine from others, such as "shepherd," when managing multiple engine types in the application.

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

 Notes:
 - This class relies on the EngineType.DRIVER enumeration value to retrieve the unique
   engine identifier.
 - The getId method is used internally by the framework to ensure the correct engine is
   activated for a guided tour.
 

Field Summary

Fields inherited from interface org.vaadin.addons.antlerflow.tour.TourEngine

GSON

Constructor Summary

Constructors

Constructor	Description
DriverEngine()

Method Summary

Modifier and Type	Method	Description
String	getId()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vaadin.addons.antlerflow.tour.TourEngine

cancel, start, wireEvents

Constructor Details

DriverEngine

public DriverEngine()

Method Details

getId

public String getId()

Specified by:

getId in interface TourEngine