de.agilecoders.wicket.extensions.markup.html.bootstrap.tour

Class TourOptions

java.lang.Object

de.agilecoders.wicket.jquery.CombinableConfig

de.agilecoders.wicket.jquery.AbstractConfig

de.agilecoders.wicket.extensions.markup.html.bootstrap.tour.TourOptions

All Implemented Interfaces:

de.agilecoders.wicket.jquery.Config, Serializable, org.apache.wicket.util.io.IClusterable

public class TourOptions
extends de.agilecoders.wicket.jquery.AbstractConfig

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TourOptions()

Method Summary

Methods

Modifier and Type	Method and Description
TourOptions	withBackdrop(boolean value) The storage system you want to use.
TourOptions	withBasepath(org.apache.wicket.model.IModel<String> value) Specify a default base path prepended to the path option of every single step.
TourOptions	withContainer(org.apache.wicket.model.IModel<String> value) Appends the step popover to a specific element.
TourOptions	withDebug(boolean value) Set this option to true to have some useful informations printed in the console.
TourOptions	withKeyboard(boolean value) This option set the left and right arrow navigation.
TourOptions	withName(org.apache.wicket.model.IModel<String> value) This option is used to build the name of the storage item where the tour state is stored.
TourOptions	withOrphan(boolean value) Allow to show the step regardless whether its element is not set, is not present in the page or is hidden.
TourOptions	withRedirect(boolean value) Set a custom function to execute as redirect function.
TourOptions	withStorage(String value) The storage system you want to use.
TourOptions	withTemplate(org.apache.wicket.model.IModel<String> value) String or function that returns a string of the HTML template for the popovers.

Methods inherited from class de.agilecoders.wicket.jquery.AbstractConfig

all, contains, get, getString, isEmpty, newKey, put, remove, toJsonString, wrap

Methods inherited from class de.agilecoders.wicket.jquery.CombinableConfig

combine, withFallback

Methods inherited from class java.lang.Object

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

Constructor Detail

TourOptions

public TourOptions()

Method Detail

withName

public TourOptions withName(org.apache.wicket.model.IModel<String> value)

This option is used to build the name of the storage item where the tour state is stored. You can initialize several tours with different names in the same page and application.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withContainer

public TourOptions withContainer(org.apache.wicket.model.IModel<String> value)

Appends the step popover to a specific element.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withKeyboard

public TourOptions withKeyboard(boolean value)

This option set the left and right arrow navigation.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withStorage

public TourOptions withStorage(String value)

The storage system you want to use. could be the objects window.localStorage, window.sessionStorage of your own object.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withDebug

public TourOptions withDebug(boolean value)

Set this option to true to have some useful informations printed in the console.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withBackdrop

public TourOptions withBackdrop(boolean value)

The storage system you want to use. could be the objects window.localStorage, window.sessionStorage of your own object.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withRedirect

public TourOptions withRedirect(boolean value)

Set a custom function to execute as redirect function. The default redirect relies on the traditional document.location.href

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withOrphan

public TourOptions withOrphan(boolean value)

Allow to show the step regardless whether its element is not set, is not present in the page or is hidden. The step is fixed positioned in the middle of the page.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withBasepath

public TourOptions withBasepath(org.apache.wicket.model.IModel<String> value)

Specify a default base path prepended to the path option of every single step. Very useful if you need to reuse the same tour on different environments or sub-projects.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.

withTemplate

public TourOptions withTemplate(org.apache.wicket.model.IModel<String> value)

String or function that returns a string of the HTML template for the popovers.

Parameters:

value - mandatory parameter

Returns:

this instance for chaining.