Package com.smartgwt.client.widgets.tour

Class TourWindow

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.smartgwt.client.widgets.BaseWidget

com.smartgwt.client.widgets.Canvas

com.smartgwt.client.widgets.layout.Layout

com.smartgwt.client.widgets.layout.VLayout

com.smartgwt.client.widgets.Window

com.smartgwt.client.widgets.tour.TourWindow

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasCloseClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRestoreClickHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasMembersChangedHandlers

public class TourWindow
extends Window

A specific purpose Window class for showing individual steps in a tour.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
TourWindow()
TourWindow(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
Boolean	actionClick()	Handles a click on the action button of this window.
Boolean	cancelClick()	Handles a click on the cancel button of this window.
static void	changeAutoChildDefaults(String autoChildName, Canvas defaults)	Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(String autoChildName, FormItem defaults)	Changes the defaults for FormItem AutoChildren named autoChildName.
protected JavaScriptObject	create()
IButton	getActionButton()	Button show below contents that will call actionClick() when clicked.
String	getActionButtonTitle()	Title for the actionButton, shown if showActionButton is true.
String	getActionButtonURL()	URL to open in another tab or window when the the actionButton is clicked.
IButton	getCancelButton()	Button show below contents that will call cancelClick() when clicked.
Boolean	getCancelButtonDisabled()	Should cancel button be disabled?
String	getCancelButtonPrompt()	Prompt displayed in hover for cancel button.
String	getCancelButtonTitle()	Title for the cancelButton, shown if showCancelButton is true.
Canvas[]	getContentComponents()	Additional content components to show below contents or title if there are no other content.
String	getContents()	Text to show in body of window.
LogicalStructureObject	getLogicalStructure()	Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
static TourWindow	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getShowActionButton()	If true, show an action button below the contents which calls actionClick() when clicked.
Boolean	getShowCancelButton()	If true, show a cancel button below the contents which calls cancelClick() when clicked.
Boolean	getShowProgress()	Should a progress bar be shown to indicate progress through the tour?
Boolean	getShowProgressPercent()	Show progress percent next to progress bar when showProgress is enabled? The percent can also be shown over the progress bar by setting showProgressPercentInline.
Boolean	getShowProgressPercentInline()	Show progress percent over the progress bar instead of next to it when showProgress is enabled?
String	getTitle()	Title for this Window, shown if showTitle is true.
TourWindow	setActionButtonTitle(String actionButtonTitle)	Title for the actionButton, shown if showActionButton is true.
TourWindow	setActionButtonURL(String actionButtonURL)	URL to open in another tab or window when the the actionButton is clicked.
TourWindow	setCancelButtonDisabled(Boolean cancelButtonDisabled)	Should cancel button be disabled?
TourWindow	setCancelButtonPrompt(String cancelButtonPrompt)	Prompt displayed in hover for cancel button.
TourWindow	setCancelButtonTitle(String cancelButtonTitle)	Title for the cancelButton, shown if showCancelButton is true.
TourWindow	setContentComponents(Canvas... contentComponents)	Additional content components to show below contents or title if there are no other content.
TourWindow	setContents(String contents)	Text to show in body of window.
static void	setDefaultProperties(TourWindow tourWindowProperties)	Class level method to set the default properties of this class.
LogicalStructureObject	setLogicalStructure(TourWindowLogicalStructure s)	Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
TourWindow	setShowActionButton(Boolean showActionButton)	If true, show an action button below the contents which calls actionClick() when clicked.
TourWindow	setShowCancelButton(Boolean showCancelButton)	If true, show a cancel button below the contents which calls cancelClick() when clicked.
TourWindow	setShowProgress(Boolean showProgress)	Should a progress bar be shown to indicate progress through the tour?
TourWindow	setShowProgressPercent(Boolean showProgressPercent)	Show progress percent next to progress bar when showProgress is enabled? The percent can also be shown over the progress bar by setting showProgressPercentInline.
TourWindow	setShowProgressPercentInline(Boolean showProgressPercentInline)	Show progress percent over the progress bar instead of next to it when showProgress is enabled?
void	setTitle(String title)	Title for this Window, shown if showTitle is true.

Methods inherited from class com.smartgwt.client.widgets.Window

addCloseClickHandler, addItem, addItem, addMaximizeClickHandler, addMember, addMember, addMinimizeClickHandler, addRestoreClickHandler, centerInPage, close, flash, getAnimateMinimize, getAutoCenter, getAutoSize, getBody, getBodyColor, getBodyStyle, getBringToFrontOnMouseUp, getCanDragReposition, getCanDragResize, getCanFocusInHeaderButtons, getCloseButton, getContentLayout, getContentsType, getDefaultMinimizeHeight, getDismissOnEscape, getDismissOnOutsideClick, getEditProxyConstructor, getFillSpaceStyleName, getFooter, getFooterHeight, getHeader, getHeaderBackground, getHeaderIcon, getHeaderLabel, getHeaderSrc, getHeaderStyle, getHiliteBodyColor, getHiliteHeaderSrc, getHiliteHeaderStyle, getIsModal, getItems, getMaximizeButton, getMaximized, getMinimizeAcceleration, getMinimizeButton, getMinimized, getMinimizeHeight, getMinimizeTime, getModalMask, getModalMaskOpacity, getModalMaskStyle, getOpacity, getPlacement, getPrintBodyStyle, getPrintHeaderStyle, getResizeFrom, getResizer, getRestoreButton, getShowBody, getShowCloseButton, getShowEdges, getShowFooter, getShowHeader, getShowHeaderBackground, getShowHeaderIcon, getShowMaximizeButton, getShowMinimizeButton, getShowModalMask, getShowResizer, getShowShadow, getShowStatusBar, getShowTitle, getSrc, getStatus, getStatusBar, getUseBackMask, maximize, minimize, preloadImages, removeItem, restore, revealChild, revealChild, setAnimateMinimize, setAutoCenter, setAutoSize, setBodyColor, setBodyDefaults, setBodyStyle, setBringToFrontOnMouseUp, setCanDragReposition, setCanDragResize, setCanFocusInHeaderButtons, setContentLayout, setContentLayout, setContentsType, setDefaultMinimizeHeight, setDefaultProperties, setDismissOnEscape, setDismissOnOutsideClick, setEditProxyConstructor, setFillSpaceStyleName, setFooterControls, setFooterHeight, setHeaderControls, setHeaderIcon, setHeaderIcon, setHeaderIconDefaults, setHeaderIconProperties, setHeaderSrc, setHeaderStyle, setHiliteBodyColor, setHiliteHeaderSrc, setHiliteHeaderStyle, setIsModal, setKeepInParentRect, setKeepInParentRect, setLogicalStructure, setMaximized, setMinimizeAcceleration, setMinimized, setMinimizeHeight, setMinimizeTime, setModalMaskOpacity, setModalMaskStyle, setOpacity, setPlacement, setPrintBodyStyle, setPrintHeaderStyle, setResizeFrom, setShowBody, setShowCloseButton, setShowEdges, setShowFooter, setShowHeader, setShowHeaderBackground, setShowHeaderIcon, setShowMaximizeButton, setShowMinimizeButton, setShowModalMask, setShowResizer, setShowShadow, setShowStatusBar, setShowTitle, setSrc, setStatus, setUseBackMask, shouldDismissOnEscape

Methods inherited from class com.smartgwt.client.widgets.layout.VLayout

setDefaultProperties, setLogicalStructure

Methods inherited from class com.smartgwt.client.widgets.layout.Layout

addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Details

TourWindow

public TourWindow()

TourWindow

public TourWindow(JavaScriptObject jsObj)

Method Details

getOrCreateRef

public static TourWindow getOrCreateRef(JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
 Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

• AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
 FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

• AutoChildUsage

create

protected JavaScriptObject create()

Overrides:

create in class Window

getActionButton

public IButton getActionButton()
                        throws IllegalStateException

Button show below contents that will call actionClick() when clicked.

This component is an AutoChild named "actionButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current actionButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setActionButtonTitle

public TourWindow setActionButtonTitle(String actionButtonTitle)
                                throws IllegalStateException

Title for the actionButton, shown if showActionButton is true.

Parameters:

actionButtonTitle - New actionButtonTitle value. Default value is "Next"

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Appearance overview and related methods

getActionButtonTitle

public String getActionButtonTitle()

Title for the actionButton, shown if showActionButton is true.

Returns:

Current actionButtonTitle value. Default value is "Next"

See Also:

• HTMLString
• Appearance overview and related methods

setActionButtonURL

public TourWindow setActionButtonURL(String actionButtonURL)
                              throws IllegalStateException

URL to open in another tab or window when the the actionButton is clicked. The normal actionClick() event is still called.

Parameters:

actionButtonURL - New actionButtonURL value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• URL

getActionButtonURL

public String getActionButtonURL()

URL to open in another tab or window when the the actionButton is clicked. The normal actionClick() event is still called.

Returns:

Current actionButtonURL value. Default value is null

See Also:

• URL

getCancelButton

public IButton getCancelButton()
                        throws IllegalStateException

Button show below contents that will call cancelClick() when clicked.

This component is an AutoChild named "cancelButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current cancelButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setCancelButtonDisabled

public TourWindow setCancelButtonDisabled(Boolean cancelButtonDisabled)
                                   throws IllegalStateException

Should cancel button be disabled?

Parameters:

cancelButtonDisabled - New cancelButtonDisabled value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getCancelButtonDisabled

public Boolean getCancelButtonDisabled()

Should cancel button be disabled?

Returns:

Current cancelButtonDisabled value. Default value is null

See Also:

• Appearance overview and related methods

setCancelButtonPrompt

public TourWindow setCancelButtonPrompt(String cancelButtonPrompt)
                                 throws IllegalStateException

Prompt displayed in hover for cancel button.

Parameters:

cancelButtonPrompt - New cancelButtonPrompt value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Appearance overview and related methods

getCancelButtonPrompt

public String getCancelButtonPrompt()

Prompt displayed in hover for cancel button.

Returns:

Current cancelButtonPrompt value. Default value is null

See Also:

• HTMLString
• Appearance overview and related methods

setCancelButtonTitle

public TourWindow setCancelButtonTitle(String cancelButtonTitle)
                                throws IllegalStateException

Title for the cancelButton, shown if showCancelButton is true.

Parameters:

cancelButtonTitle - New cancelButtonTitle value. Default value is "Skip this tour"

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Appearance overview and related methods

getCancelButtonTitle

public String getCancelButtonTitle()

Title for the cancelButton, shown if showCancelButton is true.

Returns:

Current cancelButtonTitle value. Default value is "Skip this tour"

See Also:

• HTMLString
• Appearance overview and related methods

setContentComponents

public TourWindow setContentComponents(Canvas... contentComponents)
                                throws IllegalStateException

Additional content components to show below contents or title if there are no other content.

Parameters:

contentComponents - New contentComponents value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getContentComponents

public Canvas[] getContentComponents()

Additional content components to show below contents or title if there are no other content.

Returns:

Current contentComponents value. Default value is null

setContents

public TourWindow setContents(String contents)
                       throws IllegalStateException

Text to show in body of window.

Overrides:

setContents in class Canvas

Parameters:

contents - New contents value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Appearance overview and related methods

getContents

public String getContents()

Text to show in body of window.

Overrides:

getContents in class Canvas

Returns:

Current contents value. Default value is null

See Also:

• HTMLString
• Appearance overview and related methods

setShowActionButton

public TourWindow setShowActionButton(Boolean showActionButton)
                               throws IllegalStateException

If true, show an action button below the contents which calls actionClick() when clicked.

Parameters:

showActionButton - New showActionButton value. Default value is true

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getShowActionButton

public Boolean getShowActionButton()

If true, show an action button below the contents which calls actionClick() when clicked.

Returns:

Current showActionButton value. Default value is true

See Also:

• Appearance overview and related methods

setShowCancelButton

public TourWindow setShowCancelButton(Boolean showCancelButton)
                               throws IllegalStateException

If true, show a cancel button below the contents which calls cancelClick() when clicked.

Parameters:

showCancelButton - New showCancelButton value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getShowCancelButton

public Boolean getShowCancelButton()

If true, show a cancel button below the contents which calls cancelClick() when clicked.

Returns:

Current showCancelButton value. Default value is null

See Also:

• Appearance overview and related methods

setShowProgress

public TourWindow setShowProgress(Boolean showProgress)
                           throws IllegalStateException

Should a progress bar be shown to indicate progress through the tour?

Parameters:

showProgress - New showProgress value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getShowProgress

public Boolean getShowProgress()

Should a progress bar be shown to indicate progress through the tour?

Returns:

Current showProgress value. Default value is null

setShowProgressPercent

public TourWindow setShowProgressPercent(Boolean showProgressPercent)
                                  throws IllegalStateException

Show progress percent next to progress bar when showProgress is enabled? The percent can also be shown over the progress bar by setting showProgressPercentInline.

Parameters:

showProgressPercent - New showProgressPercent value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• setShowProgressPercentInline(java.lang.Boolean)

getShowProgressPercent

public Boolean getShowProgressPercent()

Show progress percent next to progress bar when showProgress is enabled? The percent can also be shown over the progress bar by setting showProgressPercentInline.

Returns:

Current showProgressPercent value. Default value is null

See Also:

• getShowProgressPercentInline()

setShowProgressPercentInline

public TourWindow setShowProgressPercentInline(Boolean showProgressPercentInline)
                                        throws IllegalStateException

Show progress percent over the progress bar instead of next to it when showProgress is enabled?

Parameters:

showProgressPercentInline - New showProgressPercentInline value. Default value is null

Returns:

TourWindow instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getShowProgressPercentInline

public Boolean getShowProgressPercentInline()

Show progress percent over the progress bar instead of next to it when showProgress is enabled?

Returns:

Current showProgressPercentInline value. Default value is null

setTitle

public void setTitle(String title)
              throws IllegalStateException

Title for this Window, shown if showTitle is true.

Overrides:

setTitle in class Window

Parameters:

title - New title value. Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Appearance overview and related methods

getTitle

public String getTitle()

Title for this Window, shown if showTitle is true.

Overrides:

getTitle in class Window

Returns:

Current title value. Default value is null

See Also:

• HTMLString
• Appearance overview and related methods

actionClick

public Boolean actionClick()

Handles a click on the action button of this window. No default implementation.

Developers may use addActionClickHandler() to provide custom handling when the user clicks this button.

Returns:

Return false to cancel bubbling the click event

cancelClick

public Boolean cancelClick()

Handles a click on the cancel button of this window. The default implementation calls close() and returns false to prevent bubbling of the click event.

Developers may use addCancelClickHandler() to provide custom handling when the user clicks this button. Custom implementations may call close() to trigger the default behavior.

Returns:

Return false to cancel bubbling the click event

setDefaultProperties

public static void setDefaultProperties(TourWindow tourWindowProperties)

Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

Parameters:

tourWindowProperties - properties that should be used as new defaults when instances of this class are created

See Also:

• SGWTProperties

setLogicalStructure

public LogicalStructureObject setLogicalStructure(TourWindowLogicalStructure s)

Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

getLogicalStructure

public LogicalStructureObject getLogicalStructure()

Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class Window