Module wicket.bootstrap.extensions

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

Class TourBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapBaseBehavior

de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapJavascriptBehavior

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

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable

public class TourBehavior
extends de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapJavascriptBehavior

A behavior that contributes the resources needed for Bootstrap Tour.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TourBehavior()

Method Summary

Modifier and Type	Method	Description
TourBehavior	addStep(TourStep step)	Adds a step to the tour
protected CharSequence	createExtraConfig()	Allows contributing more JavaScript related to the tour.
List<TourStep>	getSteps()
protected TourOptions	getTourOptions()	Overwrite this method to modify the default tour behavior
void	renderHead(Component component, IHeaderResponse response)
final int	size()

Methods inherited from class de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapJavascriptBehavior

renderHead

Methods inherited from class de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapBaseBehavior

addTo, getBootstrapSettings, instance, removeFrom

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, beforeRender, bind, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onConfigure, onEvent, onException, onRemove, onTag, unbind

Methods inherited from class java.lang.Object

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

Constructor Details

TourBehavior

public TourBehavior()

Method Details

addStep

public TourBehavior addStep(TourStep step)

Adds a step to the tour

Parameters:

step - The tour step

Returns:

this object, for chaining.

size

public final int size()

Returns:

The number of the steps in this tour

getSteps

public List<TourStep> getSteps()

Returns:

the steps

renderHead

public void renderHead(Component component,
 IHeaderResponse response)

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class de.agilecoders.wicket.core.markup.html.bootstrap.behavior.BootstrapBaseBehavior

createExtraConfig

protected CharSequence createExtraConfig()

Allows contributing more JavaScript related to the tour. By default starts the tour.

Returns:

extra tour related JavaScript

getTourOptions

protected TourOptions getTourOptions()

Overwrite this method to modify the default tour behavior

Returns:

the tour options