Java tutorial
/************************************************************************ GwtTour.java is part of Gwt-Tour 0.1 Copyright 2013 Alain Ekambi Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. **************************************************************************/ package com.eemi.gwt.tour.client; import java.util.ArrayList; import java.util.LinkedList; import java.util.List; import java.util.Random; import com.eemi.gwt.tour.client.jso.Function; import com.eemi.gwt.tour.client.jso.TourPeer; import com.eemi.gwt.tour.client.resources.GwtTourResources; import com.google.gwt.core.client.GWT; import com.google.gwt.core.client.JavaScriptObject; import com.google.gwt.core.client.JsArray; import com.google.gwt.core.client.ScriptInjector; import com.google.gwt.dom.client.StyleInjector; /** * Main GwtTour class * * @author Alain Ekambi * */ public class GwtTour { private GwtTour() { } /** * Check if the script is loaded * @return */ public static native boolean isLoaded() /*-{ return $wnd.hopscotch !== undefined; }-*/; /** * Load the javasccript and the stylesheet by using the ScriptInjector */ public static void load() { if (!isLoaded()) { GwtTourResources resources = GWT.create(GwtTourResources.class); StyleInjector.inject(resources.css().getText()); ScriptInjector.fromString(resources.js().getText()).setWindow(ScriptInjector.TOP_WINDOW).inject(); } } /** * Actually starts the tour. * * @param tour */ public static void startTour(Tour tour) { _startTour(tour.getPeer()); } /** * Actually starts the tour. Optional stepNum argument specifies what step * to start at. * * @param tour * @param stepIndex */ public static void startTour(Tour tour, int stepIndex) { _startTour(tour.getPeer(), stepIndex); } /** * Skips to a given step in the tour * * @param index */ public static native void showStep(int index)/*-{ $wnd.hopscotch.showStep(index); }-*/; /** * Goes back one step in the tour */ public static native void prevStep()/*-{ $wnd.hopscotch.prevStep(); }-*/; /** * Goes forward one step in the tour */ public static native void nextStep()/*-{ $wnd.hopscotch.nextStep(); }-*/; public static native int getCurrStepNum()/*-{ return $wnd.hopscotch.getCurrStepNum(); }-*/; /** * Checks for tour state saved in sessionStorage/cookies and returns the state if it exists. Use this method to determine whether or not you should resume a tour. * @return */ public static native String getState()/*-{ return $wnd.hopscotch.getState(); }-*/; /** * Returns the currently running tour. * FIXME: Not yet fully implemented * @return */ public static Tour getCurrTour() { TourPeer peer = (TourPeer) _getCurrTour(); Tour tour = null; if (peer != null) { tour = new Tour(peer.getId()); JsArray<JavaScriptObject> arr = peer.getSteps(); List<TourStep> steps = null; for (int i = 0; i < arr.length(); i++) { if (steps == null) { steps = new LinkedList<TourStep>(); } JavaScriptObject jso = arr.get(i); TourStep step = new TourStep(); // TODO: Get data from jso into step } } return tour; } private static native JavaScriptObject _getCurrTour()/*-{ return $wnd.hopscotch.getCurrTour() }-*/; /** * Ends the current tour. */ public static native void endTour()/*-{ $wnd.hopscotch.endTour(); }-*/; /** * Resets i18n strings to original default values. */ public static native void restoreDefaultI18N()/*-{ $wnd.hopscotch.restoreDefaultI18N(); }-*/; /** * Ends the current tour. If clearCookie is set to false, the tour state is * preserved. Otherwise, if clearCookie is set to true or is not provided, * the tour state is cleared. */ public static native void endTour(boolean clearCookie)/*-{ $wnd.hopscotch.endTour(clearCookie); }-*/; /** * Creates callout referenced by an id. * * @param callout */ public static void createCallOut(CallOut callout) { _createCallOut(callout.getPeer()); } public static void removeCallOut(CallOut callout) { removeCallOut(callout.getId()); } public static native void removeCallOut(String id)/*-{ $wnd.hopscotch.getCalloutManager().removeCallOut(id); }-*/; /** * Removes all registered callouts from the page. */ public static native void removeAllCallOuts()/*-{ $wnd.hopscotch.getCalloutManager().removeAllCallouts(); }-*/; public static String generateId() { Random random = new Random(); return Long.toString(Math.abs(random.nextLong()), 36); } /** * Adds a callback for one of the event types. Valid event types are: start, end, next, prev, show, close, error * @param event , the event to listen to * @param callback ,the callback to call when the event occurs. */ public static native void listen(String event, Function callback)/*-{ $wnd.hopscotch.listen(event,function(){ callback.@com.eemi.gwt.tour.client.jso.Function::execute()(); }); }-*/; public static native void unlisten(String event, Function callback)/*-{ $wnd.hopscotch.unlisten(event,function(){ callback.@com.eemi.gwt.tour.client.jso.Function::execute()(); }); }-*/; private static native void _startTour(JavaScriptObject tour)/*-{ $wnd.hopscotch.startTour(tour); }-*/; private static native void _startTour(JavaScriptObject tour, int stepIndex)/*-{ $wnd.hopscotch.startTour(tour, stepIndex); }-*/; private static native void _createCallOut(JavaScriptObject callout)/*-{ $wnd.hopscotch.getCalloutManager().createCallout(callout); }-*/; }