org.appformer.kogito.bridge.client.guided.tour.service

Class GuidedTourServiceEnvelope

java.lang.Object

org.appformer.kogito.bridge.client.guided.tour.service.GuidedTourServiceEnvelope

All Implemented Interfaces:

GuidedTourService

public class GuidedTourServiceEnvelope
extends Object
implements GuidedTourService

Expose Guided Tour features provided by the native envelope on GuidedTourServiceNativeEnvelope.

Field Summary

Fields inherited from interface org.appformer.kogito.bridge.client.guided.tour.service.GuidedTourService

DEFAULT

Constructor Summary

Constructors

Constructor and Description
GuidedTourServiceEnvelope()

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Checks if the Guided Tour is enabled.
void	refresh(UserInteraction userInteraction) Refreshes the Guided Tour with a new user interaction.
void	registerTutorial(Tutorial tutorial) Registers a tutorial into the Guided Tour

Methods inherited from class java.lang.Object

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

Constructor Detail

GuidedTourServiceEnvelope

public GuidedTourServiceEnvelope()

Method Detail

refresh

public void refresh(UserInteraction userInteraction)

Description copied from interface: GuidedTourService

Refreshes the Guided Tour with a new user interaction. Thus, depending of the user interaction, the Guided Tour may react or do not react upon a given user interaction.

Specified by:

refresh in interface GuidedTourService

Parameters:

userInteraction - an user interaction

registerTutorial

public void registerTutorial(Tutorial tutorial)

Description copied from interface: GuidedTourService

Registers a tutorial into the Guided Tour

Specified by:

registerTutorial in interface GuidedTourService

Parameters:

tutorial - a tutorial

isEnabled

public boolean isEnabled()

Description copied from interface: GuidedTourService

Checks if the Guided Tour is enabled.

Specified by:

isEnabled in interface GuidedTourService

Returns:

'true' when the Guided Tour is enabled, otherwise it returns 'false'