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

Class TourBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

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

All Implemented Interfaces:

Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable

public class TourBehavior
extends org.apache.wicket.behavior.Behavior

A behavior that contributes the resources needed for Bootstrap Tour.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TourBehavior()

Method Summary

Methods

Modifier and Type	Method and 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(org.apache.wicket.Component component, org.apache.wicket.markup.head.IHeaderResponse response)
int	size()

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

afterRender, beforeRender, bind, canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onConfigure, onEvent, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

TourBehavior

public TourBehavior()

Method Detail

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(org.apache.wicket.Component component,
              org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IComponentAwareHeaderContributor

Overrides:

renderHead in class org.apache.wicket.behavior.Behavior

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