public final class GCUBEGuidedTour extends Object
| Constructor and Description |
|---|
GCUBEGuidedTour(String caption,
String className,
String userGuideURL,
int width,
int height,
boolean useMask,
ThemeColor themeColor,
ArrayList<com.google.gwt.user.client.ui.Composite> steps,
TourLanguage... languages) |
GCUBEGuidedTour(String caption,
String className,
String userGuideURL,
int width,
int height,
boolean useMask,
ThemeColor themeColor,
TourLanguage... languages) |
GCUBEGuidedTour(String caption,
String className,
String userGuideURL,
int width,
int height,
boolean useMask,
TourLanguage... languages) |
| Modifier and Type | Method and Description |
|---|---|
void |
addStep(com.google.gwt.user.client.ui.Composite stepToAdd)
add a Step to the popup, any
|
String |
getClassName() |
ThemeColor |
getColor() |
int |
getHeight() |
String |
getPortletName() |
ArrayList<com.google.gwt.user.client.ui.Composite> |
getSteps() |
TourLanguage[] |
getSupportedLanguages() |
String |
getUserGuideLink() |
int |
getWidth() |
boolean |
isMask() |
void |
openTour()
trigger the show PopUp
|
void |
openTour(boolean force)
trigger the show PopUp
|
void |
setAnimationEnabled(boolean enable)
Enable or disable the animation feature.
|
protected void |
showTour(boolean force)
Creates and shows the tour.
|
static void |
showTour(String className,
boolean skipUserPreferences,
GuidedTourResourceProvider resourceProvider,
boolean force) |
static void |
showTour(String className,
GuidedTourResourceProvider resourceProvider) |
static void |
showTour(String className,
GuidedTourResourceProvider resourceProvider,
boolean force) |
protected static void |
showTourAsync(String className,
GuidedTourResourceProvider resourceProvider,
boolean force) |
public GCUBEGuidedTour(String caption, String className, String userGuideURL, int width, int height, boolean useMask, TourLanguage... languages)
caption - what you want to append after "Quick tour guide for" in the frame captionclassName - className of your portlet class, it acts as unique iduserGuideURL - the http url of this application's user guidewidth - window width in pixelsheight - window height in pixelsuseMask - When enabled, the background will be blocked with a semi-transparent panelpublic GCUBEGuidedTour(String caption, String className, String userGuideURL, int width, int height, boolean useMask, ThemeColor themeColor, TourLanguage... languages)
caption - what you want to append after "Quick tour guide for" in the frame captionclassName - className of your portlet class, it acts as unique idwidth - window width in pixelsheight - window height in pixelsuseMask - When enabled, the background will be blocked with a semi-transparent panelthemeColor - the frame color of this popuplanguages - the languages supported by this tourpublic GCUBEGuidedTour(String caption, String className, String userGuideURL, int width, int height, boolean useMask, ThemeColor themeColor, ArrayList<com.google.gwt.user.client.ui.Composite> steps, TourLanguage... languages)
caption - what you want to append after "Quick tour guide for" in the frame captionclassName - className of your portlet class, it acts as unique idwidth - window width in pixelsheight - window height in pixelsuseMask - When enabled, the background will be blocked with a semi-transparent panelthemeColor - the frame color of this popupsteps - an ArrayList of steps. Any public void setAnimationEnabled(boolean enable)
enable - true to enable animation, false to disablepublic void addStep(com.google.gwt.user.client.ui.Composite stepToAdd)
stepToAdd - public void openTour()
steps - the steps to showpublic void openTour(boolean force)
steps - the steps to showprotected void showTour(boolean force)
public static void showTour(String className, GuidedTourResourceProvider resourceProvider, boolean force)
className - className of your portlet class, it acts as unique idresourceProvider - the resource providerforce - set to true if you want users not to be able to close it nor set it to not show againpublic static void showTour(String className, GuidedTourResourceProvider resourceProvider)
public static void showTour(String className, boolean skipUserPreferences, GuidedTourResourceProvider resourceProvider, boolean force)
className - className of your portlet class, it acts as unique idresourceProvider - the resource providerforce - set to true if you want users not to be able to close it nor set it to not show againprotected static void showTourAsync(String className, GuidedTourResourceProvider resourceProvider, boolean force)
className - className of your portlet class, it acts as unique idresourceProvider - the resource providerforce - set to true if you want users not to be able to close it nor set it to not show againpublic String getUserGuideLink()
public String getPortletName()
public String getClassName()
public ArrayList<com.google.gwt.user.client.ui.Composite> getSteps()
public int getWidth()
public int getHeight()
public boolean isMask()
public ThemeColor getColor()
public TourLanguage[] getSupportedLanguages()
Copyright © 2015. All Rights Reserved.