Module wicket.bootstrap.extensions
Package 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, IClusterable
public class TourOptions extends de.agilecoders.wicket.jquery.AbstractConfig
See Also:

  • Constructor Details

    • TourOptions

      public TourOptions()

  • Method Details

    • withName

      public TourOptions withName(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(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)
      Show a dark backdrop behind the popover and its element, highlighting the current step.
      Parameters:
      value - mandatory parameter
      Returns:
      this instance for chaining.

    • withBackdropPadding

      public TourOptions withBackdropPadding(TourOptions.BackdropPadding value)
      Add padding to the backdrop element that highlights the step element. It can be a number or a object containing optional top, right, bottom and left numbers.
      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(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.

    • withDelay

      public TourOptions withDelay(Integer value)

    • withTemplate

      public TourOptions withTemplate(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.