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

Class GuidedTourCustomSelectorPositionProvider

java.lang.Object

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

@JsType(namespace="<global>",
        name="JsInterop__Envelope__GuidedTour__GuidedTourCustomSelectorPositionProvider")
public class GuidedTourCustomSelectorPositionProvider
extends Object

Provides a JsType native API for JavaScript consumers that may request positions with a custom query selector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GuidedTourCustomSelectorPositionProvider.PositionProviderFunction

Method Summary

Modifier and Type	Method and Description
static GuidedTourCustomSelectorPositionProvider	getInstance() Gets an instance of the GuidedTourCustomSelectorPositionProvider
Rect	getPosition(String querySelector) Gets a Rect position for a given custom 'querySelector', which must follow this convention: 'TYPE:::ELEMENT'.
void	registerPositionProvider(String type, GuidedTourCustomSelectorPositionProvider.PositionProviderFunction positionProviderFunction) Registers a GuidedTourCustomSelectorPositionProvider.PositionProviderFunction with its type.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GuidedTourCustomSelectorPositionProvider getInstance()

Gets an instance of the GuidedTourCustomSelectorPositionProvider

getPosition

public Rect getPosition(String querySelector)

Gets a Rect position for a given custom 'querySelector', which must follow this convention: 'TYPE:::ELEMENT'. E.g. Graph:::Node-1, Iframe:::body, Any:::Element1.

Parameters:

querySelector - a custom query selector

Returns:

the position of the selected element

registerPositionProvider

public void registerPositionProvider(String type,
                                     GuidedTourCustomSelectorPositionProvider.PositionProviderFunction positionProviderFunction)

Registers a GuidedTourCustomSelectorPositionProvider.PositionProviderFunction with its type.

Parameters:

type - the prefix for the position provider function

positionProviderFunction - a function that returns a Rect for a given 'selector'