|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.portlets.user.guidedtour.client.GCUBEGuidedTour
public final class GCUBEGuidedTour
Constructor Summary | |
---|---|
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)
|
Method Summary | |
---|---|
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 |
setAnimationEnabled(boolean enable)
Enable or disable the animation feature. |
protected void |
showTour()
Creates and shows the tour. |
static void |
showTour(String className,
boolean skipUserPreferences,
GuidedTourResourceProvider resourceProvider)
|
static void |
showTour(String className,
GuidedTourResourceProvider resourceProvider)
|
protected static void |
showTourAsync(String className,
GuidedTourResourceProvider resourceProvider)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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 Method Detail |
---|
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 showprotected void showTour()
public static void showTour(String className, GuidedTourResourceProvider resourceProvider)
public static void showTour(String className, boolean skipUserPreferences, GuidedTourResourceProvider resourceProvider)
protected static void showTourAsync(String className, GuidedTourResourceProvider resourceProvider)
public 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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |