org.gcube.portlets.widgets.widgettour.client.extendedclasses

Class GCubeTour

java.lang.Object

com.ait.toolkit.hopscotch.client.Tour

org.gcube.portlets.widgets.widgettour.client.extendedclasses.GCubeTour

public class GCubeTour
extends com.ait.toolkit.hopscotch.client.Tour

Extended version of the Tour class by Alain Ekambi.

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	showNextTime

Constructor Summary

Constructors

Constructor and Description
GCubeTour(String id, String portletId, int versionNumber, String question, String title) Create a tour with a unique identifier.

Method Summary

Modifier and Type	Method and Description
void	startTour() Start this tour if possible (it won't start if the user said that he/she does not want to see it again).

Methods inherited from class com.ait.toolkit.hopscotch.client.Tour

addStep, getPeer, onClose, onEnd, onNext, onPrev, onStart, setArrowWidth, setBubblePadding, setBubbleWidth, setCloseTooltipTextText, setDoneBtnText, setNextBtnText, setNextOnTargetClick, setPrevBtnText, setScrollDuration, setScrollTopMargin, setShowCloseButton, setShowNextButton, setShowPrevButton, setSkipIfNoElement, setSkiptBtnText, setSmoothScroll, setStepNums, setStepNums, setSteps, setSteps

Methods inherited from class java.lang.Object

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

Field Detail

showNextTime

protected boolean showNextTime

Constructor Detail

GCubeTour

public GCubeTour(String id,
                 String portletId,
                 int versionNumber,
                 String question,
                 String title)

Create a tour with a unique identifier. Please note that you have to increase your versionNumber if you want to show a new version of the tour to the user.

Parameters:

id - unique identifier for the tour

portletId - the identifier of the portlet

versionNumber - the version of this tour

question - the question (please note that buttons 'ok', 'no' will be shown)

title - the title of the dialog-box

Method Detail

startTour

public void startTour()

Start this tour if possible (it won't start if the user said that he/she does not want to see it again).