Package com.smartgwt.client.util.tour

Class Tour

java.lang.Object
com.smartgwt.client.core.BaseClass
com.smartgwt.client.util.workflow.Process
com.smartgwt.client.util.tour.Tour
All Implemented Interfaces:
HasHandlers, HasFinishedHandlers, HasTraceElementHandlers
Direct Known Subclasses:
Tutorial
public class Tour extends Process
The Tour class allows you to build tours and tutorials for end users, highlighting specific components on the page and prompting for specific user-interactions.

Tours are a specific type of Workflow Process and consist of a series of TourSteps. Typically each step refers to an element on the page, which is either being highlighted for the user, or, for a tutorial, is an element that the user is being prompted to interact with (see TourStep.clickTarget, for example).

Most steps have a TourWindow, which shows explanatory or instructional text. For tutorial steps that request a user action, the target can be highlighted and a large arrow is shown pointing at the target.

The placement of the TourWindow and arrow is automatic, and intelligently takes into account the type of interaction requested. For example, if a tutorial requires a user to change a value in a SelectItem, the TourWindow and arrow will avoid appearing underneath the select, where they could be occluded by the drop-down picklist. Similarly, for a drag and drop interaction, the TourWindow avoids overlapping both the drag source and the drop area.

Because of all this automatic behavior, a tutorial step typically consists of just:

1. explanatory text (tourStep.title and tourStep.description)
2. the target
3. the expected interaction (eg click the target, or type something in, or drag something to another widget)
4. validation of input (what was typed or chosen), if applicable

Developers may use AutoTest locators to specify specific components or elements as action targets. Using locators means that tours and tutorials will typically still work even if your application changes (for example, new controls are added). Note that we recommend making use of the locator shortcut to rapidly generate locators.

A tour is typically written as a .proc.xml document stored in the folder configured via the project.processes setting in server.properties (webroot/processes by default). They may be loaded via the loadTour() method.

The Tour feature is available with Power or better licenses only See smartclient.com/product for details.
It requires the standard DataBinding and optional Tour module.

  • Constructor Details

  • Method Details

    • getOrCreateRef

      public static Tour getOrCreateRef(JavaScriptObject jsObj)

    • create

      public JavaScriptObject create()
      Overrides:
      create in class Process

    • setAllowDropOnDescendants

      public Tour setAllowDropOnDescendants(boolean allowDropOnDescendants)
      Default value for TourStep.allowDropOnDescendants within this tour.
      Parameters:
      allowDropOnDescendants - New allowDropOnDescendants value. Default value is false
      Returns:
      Tour instance, for chaining setter calls

    • getAllowDropOnDescendants

      public boolean getAllowDropOnDescendants()
      Default value for TourStep.allowDropOnDescendants within this tour.
      Returns:
      Current allowDropOnDescendants value. Default value is false

    • setAutoReset

      public Tour setAutoReset(Boolean autoReset) throws IllegalStateException
      Should tour be auto-reset once it finishes in any manner so it can restarted?
      Parameters:
      autoReset - New autoReset value. Default value is true
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getAutoReset

      public Boolean getAutoReset()
      Should tour be auto-reset once it finishes in any manner so it can restarted?
      Returns:
      Current autoReset value. Default value is true

    • setCanCancel

      public Tour setCanCancel(Boolean canCancel) throws IllegalStateException
      Set to false to prevent tour steps from allowing the user to cancel the tour. By default the cancel button will still be shown but is disabled. Set showCancelButton to false to suppress the cancel button entirely.

      Any time the cancel button is visible, its hover can be customized via stepCancelButtonPrompt. For canCancel:false tours where the cancel button is not hidden, a custom prompt may be useful to provide an explanation to the user as the tour can't be canceled.

      Parameters:
      canCancel - New canCancel value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getCanCancel

      public Boolean getCanCancel()
      Set to false to prevent tour steps from allowing the user to cancel the tour. By default the cancel button will still be shown but is disabled. Set showCancelButton to false to suppress the cancel button entirely.

      Any time the cancel button is visible, its hover can be customized via stepCancelButtonPrompt. For canCancel:false tours where the cancel button is not hidden, a custom prompt may be useful to provide an explanation to the user as the tour can't be canceled.

      Returns:
      Current canCancel value. Default value is null

    • setCancelSteps

      public Tour setCancelSteps(ProcessElement... cancelSteps) throws IllegalStateException
      The ProcessElements representing steps that should be performed if the user cancels the tour. These steps are typically TourSteps.

      Alternately, or in addition to these cancelation steps, the finished method will be called once there are no more steps to process in the tour.

      Parameters:
      cancelSteps - New cancelSteps value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getCancelSteps

      public ProcessElement[] getCancelSteps()
      The ProcessElements representing steps that should be performed if the user cancels the tour. These steps are typically TourSteps.

      Alternately, or in addition to these cancelation steps, the finished method will be called once there are no more steps to process in the tour.

      Returns:
      Current cancelSteps value. Default value is null

    • setDropOutlineBorder

      public Tour setDropOutlineBorder(String dropOutlineBorder)
      Set the CSS border of the outline for drop targets as a CSS string including border-width, border-style, and/or color (eg "1px dashed blue"). See outlineBorder for properties applied to non-drop targets.

      This property applies the same border to all four sides of the outlined component(s).

      Parameters:
      dropOutlineBorder - New dropOutlineBorder value. Default value is "1px solid #44ff44"
      Returns:
      Tour instance, for chaining setter calls
      See Also:

    • getDropOutlineBorder

      public String getDropOutlineBorder()
      Set the CSS border of the outline for drop targets as a CSS string including border-width, border-style, and/or color (eg "1px dashed blue"). See outlineBorder for properties applied to non-drop targets.

      This property applies the same border to all four sides of the outlined component(s).

      Returns:
      Current dropOutlineBorder value. Default value is "1px solid #44ff44"
      See Also:

    • setFirstStepActionButtonTitle

      public Tour setFirstStepActionButtonTitle(String firstStepActionButtonTitle) throws IllegalStateException
      Default value of TourStep.actionButtonTitle for the first step in the tour.

      Default titles for the middle and last steps are configured by stepActionButtonTitle and lastStepActionButtonTitle respectively.

      Parameters:
      firstStepActionButtonTitle - New firstStepActionButtonTitle value. Default value is "Let's go!"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getFirstStepActionButtonTitle

      public String getFirstStepActionButtonTitle()
      Default value of TourStep.actionButtonTitle for the first step in the tour.

      Default titles for the middle and last steps are configured by stepActionButtonTitle and lastStepActionButtonTitle respectively.

      Returns:
      Current firstStepActionButtonTitle value. Default value is "Let's go!"
      See Also:

    • setFirstStepCancelButtonTitle

      public Tour setFirstStepCancelButtonTitle(String firstStepCancelButtonTitle) throws IllegalStateException
      Default value of TourStep.cancelButtonTitle for the first step in the tour.

      Default title for the middle steps is configured by stepCancelButtonTitle. No cancel button is shown for the last step.

      Parameters:
      firstStepCancelButtonTitle - New firstStepCancelButtonTitle value. Default value is "Skip this tour"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getFirstStepCancelButtonTitle

      public String getFirstStepCancelButtonTitle()
      Default value of TourStep.cancelButtonTitle for the first step in the tour.

      Default title for the middle steps is configured by stepCancelButtonTitle. No cancel button is shown for the last step.

      Returns:
      Current firstStepCancelButtonTitle value. Default value is "Skip this tour"
      See Also:

    • setLastStepActionButtonTitle

      public Tour setLastStepActionButtonTitle(String lastStepActionButtonTitle) throws IllegalStateException
      Default value of TourStep.actionButtonTitle for the last step in the tour.

      Default titles for the first and middle steps are configured by firstStepActionButtonTitle and stepActionButtonTitle respectively.

      Parameters:
      lastStepActionButtonTitle - New lastStepActionButtonTitle value. Default value is "Done"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getLastStepActionButtonTitle

      public String getLastStepActionButtonTitle()
      Default value of TourStep.actionButtonTitle for the last step in the tour.

      Default titles for the first and middle steps are configured by firstStepActionButtonTitle and stepActionButtonTitle respectively.

      Returns:
      Current lastStepActionButtonTitle value. Default value is "Done"
      See Also:

    • setMode

      public Tour setMode(TourMode mode)
      The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.
      Parameters:
      mode - New mode value. Default value is "tour"
      Returns:
      Tour instance, for chaining setter calls

    • getMode

      public TourMode getMode()
      The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.
      Returns:
      Current mode value. Default value is "tour"

    • setNotifyMessageSettings

      public Tour setNotifyMessageSettings(NotifySettings notifyMessageSettings) throws IllegalStateException
      Defaults settings for notifyType message displayed by notifyValidationMessage.
      Parameters:
      notifyMessageSettings - New notifyMessageSettings value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getNotifyMessageSettings

      public NotifySettings getNotifyMessageSettings()
      Defaults settings for notifyType message displayed by notifyValidationMessage.
      Returns:
      Current notifyMessageSettings value. Default value is null

    • setNotifyType

      public Tour setNotifyType(String notifyType) throws IllegalStateException
      Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.

      If this category has not been configured in Notify it will be automatically configured using +{notifyMessageSettings,notifyMessageSettings}.

      Parameters:
      notifyType - New notifyType value. Default value is "tourExpectedValue"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getNotifyType

      public String getNotifyType()
      Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.

      If this category has not been configured in Notify it will be automatically configured using +{notifyMessageSettings,notifyMessageSettings}.

      Returns:
      Current notifyType value. Default value is "tourExpectedValue"
      See Also:

    • setOutlineBorder

      public Tour setOutlineBorder(String outlineBorder)
      Set the CSS border of the outline of non-drop targets as a CSS string including border-width, border-style, and/or color (eg "1px dashed blue"). See dropOutlineBorder for properties applied to drop targets.

      This property applies the same border to all four sides of the outlined component(s).

      Parameters:
      outlineBorder - New outlineBorder value. Default value is "1px solid red"
      Returns:
      Tour instance, for chaining setter calls
      See Also:

    • getOutlineBorder

      public String getOutlineBorder()
      Set the CSS border of the outline of non-drop targets as a CSS string including border-width, border-style, and/or color (eg "1px dashed blue"). See dropOutlineBorder for properties applied to drop targets.

      This property applies the same border to all four sides of the outlined component(s).

      Returns:
      Current outlineBorder value. Default value is "1px solid red"
      See Also:

    • setShowCancelButton

      public Tour setShowCancelButton(Boolean showCancelButton) throws IllegalStateException
      This property allows you to override the TourWindow.showCancelButton to hide the cancel button for all steps of the tour.

      See also canCancel

      Parameters:
      showCancelButton - New showCancelButton value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowCancelButton

      public Boolean getShowCancelButton()
      This property allows you to override the TourWindow.showCancelButton to hide the cancel button for all steps of the tour.

      See also canCancel

      Returns:
      Current showCancelButton value. Default value is null

    • setShowInputValidationMessage

      public Tour setShowInputValidationMessage(Boolean showInputValidationMessage) throws IllegalStateException
      Should TourStep.inputValidationNotifyMessage be shown as detailed in TourInputValidationMode for the entire tour? Set to false to suppress reporting messages to the user. notifyValidationMessage will not be called.

      This setting can be overridden for individual tourSteps.

      Parameters:
      showInputValidationMessage - New showInputValidationMessage value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowInputValidationMessage

      public Boolean getShowInputValidationMessage()
      Should TourStep.inputValidationNotifyMessage be shown as detailed in TourInputValidationMode for the entire tour? Set to false to suppress reporting messages to the user. notifyValidationMessage will not be called.

      This setting can be overridden for individual tourSteps.

      Returns:
      Current showInputValidationMessage value. Default value is null

    • setShowProgress

      public Tour setShowProgress(Boolean showProgress) throws IllegalStateException
      Should a progress bar be shown in each step to indicate progress through the tour?
      Parameters:
      showProgress - New showProgress value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowProgress

      public Boolean getShowProgress()
      Should a progress bar be shown in each step to indicate progress through the tour?
      Returns:
      Current showProgress value. Default value is null

    • setShowProgressPercent

      public Tour setShowProgressPercent(Boolean showProgressPercent) throws IllegalStateException
      Show progress percent next to progress bar when showProgress is enabled?
      Parameters:
      showProgressPercent - New showProgressPercent value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowProgressPercent

      public Boolean getShowProgressPercent()
      Show progress percent next to progress bar when showProgress is enabled?
      Returns:
      Current showProgressPercent value. Default value is null

    • setStepActionButtonTitle

      public Tour setStepActionButtonTitle(String stepActionButtonTitle) throws IllegalStateException
      Default value for TourStep.actionButtonTitle for steps other than the first and last ones.

      Default titles for the first and last steps are configured by firstStepActionButtonTitle and lastStepActionButtonTitle respectively.

      Parameters:
      stepActionButtonTitle - New stepActionButtonTitle value. Default value is "Next"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getStepActionButtonTitle

      public String getStepActionButtonTitle()
      Default value for TourStep.actionButtonTitle for steps other than the first and last ones.

      Default titles for the first and last steps are configured by firstStepActionButtonTitle and lastStepActionButtonTitle respectively.

      Returns:
      Current stepActionButtonTitle value. Default value is "Next"
      See Also:

    • setStepCancelButtonPrompt

      public Tour setStepCancelButtonPrompt(String stepCancelButtonPrompt) throws IllegalStateException
      Prompt displayed in hover for cancel button.
      Parameters:
      stepCancelButtonPrompt - New stepCancelButtonPrompt value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getStepCancelButtonPrompt

      public String getStepCancelButtonPrompt()
      Prompt displayed in hover for cancel button.
      Returns:
      Current stepCancelButtonPrompt value. Default value is null
      See Also:

    • setStepCancelButtonTitle

      public Tour setStepCancelButtonTitle(String stepCancelButtonTitle) throws IllegalStateException
      Default value for TourStep.cancelButtonTitle for all steps where the cancel button is shown.

      Default title for the first step is configured by firstStepCancelButtonTitle.

      Parameters:
      stepCancelButtonTitle - New stepCancelButtonTitle value. Default value is "Skip this tour"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getStepCancelButtonTitle

      public String getStepCancelButtonTitle()
      Default value for TourStep.cancelButtonTitle for all steps where the cancel button is shown.

      Default title for the first step is configured by firstStepCancelButtonTitle.

      Returns:
      Current stepCancelButtonTitle value. Default value is "Skip this tour"
      See Also:

    • setSteps

      public Tour setSteps(ProcessElement... steps) throws IllegalStateException
      The ProcessElements representing steps in this tour. These steps are typically TourSteps.
      Parameters:
      steps - New steps value. Default value is null
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getSteps

      public ProcessElement[] getSteps()
      The ProcessElements representing steps in this tour. These steps are typically TourSteps.
      Returns:
      Current steps value. Default value is null

    • setTourCompleteMakeChangesButtonTitle

      public Tour setTourCompleteMakeChangesButtonTitle(String tourCompleteMakeChangesButtonTitle) throws IllegalStateException
      Title for the Make Changes... button in the TourComplete dialog.
      Parameters:
      tourCompleteMakeChangesButtonTitle - New tourCompleteMakeChangesButtonTitle value. Default value is "Make Changes..."
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourCompleteMakeChangesButtonTitle

      public String getTourCompleteMakeChangesButtonTitle()
      Title for the Make Changes... button in the TourComplete dialog.
      Returns:
      Current tourCompleteMakeChangesButtonTitle value. Default value is "Make Changes..."
      See Also:

    • setTourCompleteRunTourButtonTitle

      public Tour setTourCompleteRunTourButtonTitle(String tourCompleteRunTourButtonTitle) throws IllegalStateException
      Title for the View XML button in the TourComplete dialog.
      Parameters:
      tourCompleteRunTourButtonTitle - New tourCompleteRunTourButtonTitle value. Default value is "Run Tour"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourCompleteRunTourButtonTitle

      public String getTourCompleteRunTourButtonTitle()
      Title for the View XML button in the TourComplete dialog.
      Returns:
      Current tourCompleteRunTourButtonTitle value. Default value is "Run Tour"
      See Also:

    • setTourCompleteTitle

      public Tour setTourCompleteTitle(String tourCompleteTitle) throws IllegalStateException
      Title for the Tour Complete dialog displayed after recording a Tour.
      Parameters:
      tourCompleteTitle - New tourCompleteTitle value. Default value is "New Tour Recording Complete"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourCompleteTitle

      public String getTourCompleteTitle()
      Title for the Tour Complete dialog displayed after recording a Tour.
      Returns:
      Current tourCompleteTitle value. Default value is "New Tour Recording Complete"
      See Also:

    • setTourCompleteTourIdTitle

      public Tour setTourCompleteTourIdTitle(String tourCompleteTourIdTitle) throws IllegalStateException
      Title for the Tour ID field in the TourComplete dialog.
      Parameters:
      tourCompleteTourIdTitle - New tourCompleteTourIdTitle value. Default value is "Tour ID"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourCompleteTourIdTitle

      public String getTourCompleteTourIdTitle()
      Title for the Tour ID field in the TourComplete dialog.
      Returns:
      Current tourCompleteTourIdTitle value. Default value is "Tour ID"
      See Also:

    • setTourCompleteViewXMLButtonTitle

      public Tour setTourCompleteViewXMLButtonTitle(String tourCompleteViewXMLButtonTitle) throws IllegalStateException
      Title for the View XML button in the TourComplete dialog.
      Parameters:
      tourCompleteViewXMLButtonTitle - New tourCompleteViewXMLButtonTitle value. Default value is "View XML"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourCompleteViewXMLButtonTitle

      public String getTourCompleteViewXMLButtonTitle()
      Title for the View XML button in the TourComplete dialog.
      Returns:
      Current tourCompleteViewXMLButtonTitle value. Default value is "View XML"
      See Also:

    • setTourStepWizardActionTypeTitle

      public Tour setTourStepWizardActionTypeTitle(String tourStepWizardActionTypeTitle) throws IllegalStateException
      Title for the Action Type field in the TourStep Wizard.
      Parameters:
      tourStepWizardActionTypeTitle - New tourStepWizardActionTypeTitle value. Default value is "Action Type"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardActionTypeTitle

      public String getTourStepWizardActionTypeTitle()
      Title for the Action Type field in the TourStep Wizard.
      Returns:
      Current tourStepWizardActionTypeTitle value. Default value is "Action Type"
      See Also:

    • setTourStepWizardAutoCompletePrompt

      public Tour setTourStepWizardAutoCompletePrompt(String tourStepWizardAutoCompletePrompt) throws IllegalStateException
      Prompt for the Auto Complete field in the TourStep Wizard.
      Parameters:
      tourStepWizardAutoCompletePrompt - New tourStepWizardAutoCompletePrompt value. Default value is "Should the tour move forward when the user completes the chosen action?"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardAutoCompletePrompt

      public String getTourStepWizardAutoCompletePrompt()
      Prompt for the Auto Complete field in the TourStep Wizard.
      Returns:
      Current tourStepWizardAutoCompletePrompt value. Default value is "Should the tour move forward when the user completes the chosen action?"
      See Also:

    • setTourStepWizardAutoCompleteTitle

      public Tour setTourStepWizardAutoCompleteTitle(String tourStepWizardAutoCompleteTitle) throws IllegalStateException
      Title for the Auto Complete field in the TourStep Wizard.
      Parameters:
      tourStepWizardAutoCompleteTitle - New tourStepWizardAutoCompleteTitle value. Default value is "Auto Complete"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardAutoCompleteTitle

      public String getTourStepWizardAutoCompleteTitle()
      Title for the Auto Complete field in the TourStep Wizard.
      Returns:
      Current tourStepWizardAutoCompleteTitle value. Default value is "Auto Complete"
      See Also:

    • setTourStepWizardBindOutputHint

      public Tour setTourStepWizardBindOutputHint(String tourStepWizardBindOutputHint) throws IllegalStateException
      Hint for the Bind Output field in the TourStep Wizard.
      Parameters:
      tourStepWizardBindOutputHint - New tourStepWizardBindOutputHint value. Default value is "Bind to variable for later use"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardBindOutputHint

      public String getTourStepWizardBindOutputHint()
      Hint for the Bind Output field in the TourStep Wizard.
      Returns:
      Current tourStepWizardBindOutputHint value. Default value is "Bind to variable for later use"
      See Also:

    • setTourStepWizardBindOutputTitle

      public Tour setTourStepWizardBindOutputTitle(String tourStepWizardBindOutputTitle) throws IllegalStateException
      Title for the Bind Output field in the TourStep Wizard.
      Parameters:
      tourStepWizardBindOutputTitle - New tourStepWizardBindOutputTitle value. Default value is "Bind Output"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardBindOutputTitle

      public String getTourStepWizardBindOutputTitle()
      Title for the Bind Output field in the TourStep Wizard.
      Returns:
      Current tourStepWizardBindOutputTitle value. Default value is "Bind Output"
      See Also:

    • setTourStepWizardCaseSensitiveTitle

      public Tour setTourStepWizardCaseSensitiveTitle(String tourStepWizardCaseSensitiveTitle) throws IllegalStateException
      Title for the Case Sensitive field in the TourStep Wizard.
      Parameters:
      tourStepWizardCaseSensitiveTitle - New tourStepWizardCaseSensitiveTitle value. Default value is "Case Sensitive"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardCaseSensitiveTitle

      public String getTourStepWizardCaseSensitiveTitle()
      Title for the Case Sensitive field in the TourStep Wizard.
      Returns:
      Current tourStepWizardCaseSensitiveTitle value. Default value is "Case Sensitive"
      See Also:

    • setTourStepWizardDoneButtonTitle

      public Tour setTourStepWizardDoneButtonTitle(String tourStepWizardDoneButtonTitle) throws IllegalStateException
      Title for the Done button in the TourStep Wizard.
      Parameters:
      tourStepWizardDoneButtonTitle - New tourStepWizardDoneButtonTitle value. Default value is "Done"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardDoneButtonTitle

      public String getTourStepWizardDoneButtonTitle()
      Title for the Done button in the TourStep Wizard.
      Returns:
      Current tourStepWizardDoneButtonTitle value. Default value is "Done"
      See Also:

    • setTourStepWizardDropTargetHint

      public Tour setTourStepWizardDropTargetHint(String tourStepWizardDropTargetHint) throws IllegalStateException
      Hint for the Drop Target field in the TourStep Wizard.
      Parameters:
      tourStepWizardDropTargetHint - New tourStepWizardDropTargetHint value. Default value is "No drop target"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardDropTargetHint

      public String getTourStepWizardDropTargetHint()
      Hint for the Drop Target field in the TourStep Wizard.
      Returns:
      Current tourStepWizardDropTargetHint value. Default value is "No drop target"
      See Also:

    • setTourStepWizardDropTargetNotifyText

      public Tour setTourStepWizardDropTargetNotifyText(String tourStepWizardDropTargetNotifyText) throws IllegalStateException
      Descriptive text displayed in a popup notification window when a Drop Target is selected for this TourStep.
      Parameters:
      tourStepWizardDropTargetNotifyText - New tourStepWizardDropTargetNotifyText value. Default value is "Shift+Click on the app to record a drop target locator"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardDropTargetNotifyText

      public String getTourStepWizardDropTargetNotifyText()
      Descriptive text displayed in a popup notification window when a Drop Target is selected for this TourStep.
      Returns:
      Current tourStepWizardDropTargetNotifyText value. Default value is "Shift+Click on the app to record a drop target locator"
      See Also:

    • setTourStepWizardDropTargetPrompt

      public Tour setTourStepWizardDropTargetPrompt(String tourStepWizardDropTargetPrompt) throws IllegalStateException
      Prompt for the Drop Target field in the TourStep Wizard.
      Parameters:
      tourStepWizardDropTargetPrompt - New tourStepWizardDropTargetPrompt value. Default value is "Click icon, then Shift+Click within the application to add a drop target"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardDropTargetPrompt

      public String getTourStepWizardDropTargetPrompt()
      Prompt for the Drop Target field in the TourStep Wizard.
      Returns:
      Current tourStepWizardDropTargetPrompt value. Default value is "Click icon, then Shift+Click within the application to add a drop target"
      See Also:

    • setTourStepWizardDropTargetTitle

      public Tour setTourStepWizardDropTargetTitle(String tourStepWizardDropTargetTitle) throws IllegalStateException
      Title for the Drop Target field in the TourStep Wizard.
      Parameters:
      tourStepWizardDropTargetTitle - New tourStepWizardDropTargetTitle value. Default value is "Drop Target"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardDropTargetTitle

      public String getTourStepWizardDropTargetTitle()
      Title for the Drop Target field in the TourStep Wizard.
      Returns:
      Current tourStepWizardDropTargetTitle value. Default value is "Drop Target"
      See Also:

    • setTourStepWizardExpectedValueHint

      public Tour setTourStepWizardExpectedValueHint(String tourStepWizardExpectedValueHint) throws IllegalStateException
      Hint for the Expected Value field in the TourStep Wizard.
      Parameters:
      tourStepWizardExpectedValueHint - New tourStepWizardExpectedValueHint value. Default value is "Value for the user to enter"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardExpectedValueHint

      public String getTourStepWizardExpectedValueHint()
      Hint for the Expected Value field in the TourStep Wizard.
      Returns:
      Current tourStepWizardExpectedValueHint value. Default value is "Value for the user to enter"
      See Also:

    • setTourStepWizardExpectedValueTitle

      public Tour setTourStepWizardExpectedValueTitle(String tourStepWizardExpectedValueTitle) throws IllegalStateException
      Title for the Expected Value field in the TourStep Wizard.
      Parameters:
      tourStepWizardExpectedValueTitle - New tourStepWizardExpectedValueTitle value. Default value is "Expected Value"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardExpectedValueTitle

      public String getTourStepWizardExpectedValueTitle()
      Title for the Expected Value field in the TourStep Wizard.
      Returns:
      Current tourStepWizardExpectedValueTitle value. Default value is "Expected Value"
      See Also:

    • setTourStepWizardInstructionsTitle

      public Tour setTourStepWizardInstructionsTitle(String tourStepWizardInstructionsTitle) throws IllegalStateException
      Title for the Instructions field in the TourStep Wizard.
      Parameters:
      tourStepWizardInstructionsTitle - New tourStepWizardInstructionsTitle value. Default value is "Instructions"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardInstructionsTitle

      public String getTourStepWizardInstructionsTitle()
      Title for the Instructions field in the TourStep Wizard.
      Returns:
      Current tourStepWizardInstructionsTitle value. Default value is "Instructions"
      See Also:

    • setTourStepWizardNextStepButtonTitle

      public Tour setTourStepWizardNextStepButtonTitle(String tourStepWizardNextStepButtonTitle) throws IllegalStateException
      Title for the Next Step button in the TourStep Wizard.
      Parameters:
      tourStepWizardNextStepButtonTitle - New tourStepWizardNextStepButtonTitle value. Default value is "Next Step"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardNextStepButtonTitle

      public String getTourStepWizardNextStepButtonTitle()
      Title for the Next Step button in the TourStep Wizard.
      Returns:
      Current tourStepWizardNextStepButtonTitle value. Default value is "Next Step"
      See Also:

    • setTourStepWizardNoStepsMessage

      public Tour setTourStepWizardNoStepsMessage(String tourStepWizardNoStepsMessage) throws IllegalStateException
      Empty message for the grid in the Tour Wizard when no steps are present.
      Parameters:
      tourStepWizardNoStepsMessage - New tourStepWizardNoStepsMessage value. Default value is "No Tour Steps Recorded"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardNoStepsMessage

      public String getTourStepWizardNoStepsMessage()
      Empty message for the grid in the Tour Wizard when no steps are present.
      Returns:
      Current tourStepWizardNoStepsMessage value. Default value is "No Tour Steps Recorded"
      See Also:

    • setTourStepWizardRecordStepHeaderPrompt

      public Tour setTourStepWizardRecordStepHeaderPrompt(String tourStepWizardRecordStepHeaderPrompt) throws IllegalStateException
      Prompt for the Record Step window header in the TourStep Wizard.
      Parameters:
      tourStepWizardRecordStepHeaderPrompt - New tourStepWizardRecordStepHeaderPrompt value. Default value is "Drag this window out of the way to get at UI within the application"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardRecordStepHeaderPrompt

      public String getTourStepWizardRecordStepHeaderPrompt()
      Prompt for the Record Step window header in the TourStep Wizard.
      Returns:
      Current tourStepWizardRecordStepHeaderPrompt value. Default value is "Drag this window out of the way to get at UI within the application"
      See Also:

    • setTourStepWizardRecordStepTitle

      public Tour setTourStepWizardRecordStepTitle(String tourStepWizardRecordStepTitle) throws IllegalStateException
      Title for the Record Tour Step window in the TourStep Wizard.
      Parameters:
      tourStepWizardRecordStepTitle - New tourStepWizardRecordStepTitle value. Default value is "Record Tour Step"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardRecordStepTitle

      public String getTourStepWizardRecordStepTitle()
      Title for the Record Tour Step window in the TourStep Wizard.
      Returns:
      Current tourStepWizardRecordStepTitle value. Default value is "Record Tour Step"
      See Also:

    • setTourStepWizardTargeNotifyText

      public Tour setTourStepWizardTargeNotifyText(String tourStepWizardTargeNotifyText) throws IllegalStateException
      Descriptive text displayed in a popup notification window when a Target is selected for this TourStep.
      Parameters:
      tourStepWizardTargeNotifyText - New tourStepWizardTargeNotifyText value. Default value is "Shift+Click on the app to record a target locator"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardTargeNotifyText

      public String getTourStepWizardTargeNotifyText()
      Descriptive text displayed in a popup notification window when a Target is selected for this TourStep.
      Returns:
      Current tourStepWizardTargeNotifyText value. Default value is "Shift+Click on the app to record a target locator"
      See Also:

    • setTourStepWizardTargePrompt

      public Tour setTourStepWizardTargePrompt(String tourStepWizardTargePrompt) throws IllegalStateException
      Prompt for the Target field in the TourStep Wizard.
      Parameters:
      tourStepWizardTargePrompt - New tourStepWizardTargePrompt value. Default value is "Click icon, then Shift+Click within the application to add a target"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardTargePrompt

      public String getTourStepWizardTargePrompt()
      Prompt for the Target field in the TourStep Wizard.
      Returns:
      Current tourStepWizardTargePrompt value. Default value is "Click icon, then Shift+Click within the application to add a target"
      See Also:

    • setTourStepWizardTargetTitle

      public Tour setTourStepWizardTargetTitle(String tourStepWizardTargetTitle) throws IllegalStateException
      Title for the Target field in the TourStep Wizard.
      Parameters:
      tourStepWizardTargetTitle - New tourStepWizardTargetTitle value. Default value is "Target"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardTargetTitle

      public String getTourStepWizardTargetTitle()
      Title for the Target field in the TourStep Wizard.
      Returns:
      Current tourStepWizardTargetTitle value. Default value is "Target"
      See Also:

    • setTourStepWizardTitle

      public Tour setTourStepWizardTitle(String tourStepWizardTitle) throws IllegalStateException
      Title for the TourStep Title field in the TourStep Wizard.
      Parameters:
      tourStepWizardTitle - New tourStepWizardTitle value. Default value is "Title"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourStepWizardTitle

      public String getTourStepWizardTitle()
      Title for the TourStep Title field in the TourStep Wizard.
      Returns:
      Current tourStepWizardTitle value. Default value is "Title"
      See Also:

    • setTourWizardInteractiveTourTitle

      public Tour setTourWizardInteractiveTourTitle(String tourWizardInteractiveTourTitle) throws IllegalStateException
      Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.
      Parameters:
      tourWizardInteractiveTourTitle - New tourWizardInteractiveTourTitle value. Default value is "Interactive Tutorial"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardInteractiveTourTitle

      public String getTourWizardInteractiveTourTitle()
      Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.
      Returns:
      Current tourWizardInteractiveTourTitle value. Default value is "Interactive Tutorial"
      See Also:

    • setTourWizardNewScreenPickerTitle

      public Tour setTourWizardNewScreenPickerTitle(String tourWizardNewScreenPickerTitle) throws IllegalStateException
      Title for the Start with New Screen picker in the Tour Wizard.
      Parameters:
      tourWizardNewScreenPickerTitle - New tourWizardNewScreenPickerTitle value. Default value is "Start With New Screen"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardNewScreenPickerTitle

      public String getTourWizardNewScreenPickerTitle()
      Title for the Start with New Screen picker in the Tour Wizard.
      Returns:
      Current tourWizardNewScreenPickerTitle value. Default value is "Start With New Screen"
      See Also:

    • setTourWizardRecordButtonTitle

      public Tour setTourWizardRecordButtonTitle(String tourWizardRecordButtonTitle) throws IllegalStateException
      Title for the Record Tour button in the Tour Wizard.
      Parameters:
      tourWizardRecordButtonTitle - New tourWizardRecordButtonTitle value. Default value is "Record Tour"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardRecordButtonTitle

      public String getTourWizardRecordButtonTitle()
      Title for the Record Tour button in the Tour Wizard.
      Returns:
      Current tourWizardRecordButtonTitle value. Default value is "Record Tour"
      See Also:

    • setTourWizardReifyTourTitle

      public Tour setTourWizardReifyTourTitle(String tourWizardReifyTourTitle) throws IllegalStateException
      Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.
      Parameters:
      tourWizardReifyTourTitle - New tourWizardReifyTourTitle value. Default value is "Reify Tutorial"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardReifyTourTitle

      public String getTourWizardReifyTourTitle()
      Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.
      Returns:
      Current tourWizardReifyTourTitle value. Default value is "Reify Tutorial"
      See Also:

    • setTourWizardRequiredDataSourcesHint

      public Tour setTourWizardRequiredDataSourcesHint(String tourWizardRequiredDataSourcesHint) throws IllegalStateException
      Hint text for the Required DataSources item in the Tour Wizard.
      Parameters:
      tourWizardRequiredDataSourcesHint - New tourWizardRequiredDataSourcesHint value. Default value is "Comma separated list of required DS's"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardRequiredDataSourcesHint

      public String getTourWizardRequiredDataSourcesHint()
      Hint text for the Required DataSources item in the Tour Wizard.
      Returns:
      Current tourWizardRequiredDataSourcesHint value. Default value is "Comma separated list of required DS's"
      See Also:

    • setTourWizardRequiredDataSourcesTitle

      public Tour setTourWizardRequiredDataSourcesTitle(String tourWizardRequiredDataSourcesTitle) throws IllegalStateException
      Title for the Required DataSources item in the Tour Wizard.
      Parameters:
      tourWizardRequiredDataSourcesTitle - New tourWizardRequiredDataSourcesTitle value. Default value is "Required DataSources"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardRequiredDataSourcesTitle

      public String getTourWizardRequiredDataSourcesTitle()
      Title for the Required DataSources item in the Tour Wizard.
      Returns:
      Current tourWizardRequiredDataSourcesTitle value. Default value is "Required DataSources"
      See Also:

    • setTourWizardShowProgressTitle

      public Tour setTourWizardShowProgressTitle(String tourWizardShowProgressTitle) throws IllegalStateException
      Title for the Show Progress picker in the Tour Wizard.
      Parameters:
      tourWizardShowProgressTitle - New tourWizardShowProgressTitle value. Default value is "Show Progress"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardShowProgressTitle

      public String getTourWizardShowProgressTitle()
      Title for the Show Progress picker in the Tour Wizard.
      Returns:
      Current tourWizardShowProgressTitle value. Default value is "Show Progress"
      See Also:

    • setTourWizardTitle

      public Tour setTourWizardTitle(String tourWizardTitle) throws IllegalStateException
      Title for the Tour Wizard.
      Parameters:
      tourWizardTitle - New tourWizardTitle value. Default value is "New Tour Configuration"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardTitle

      public String getTourWizardTitle()
      Title for the Tour Wizard.
      Returns:
      Current tourWizardTitle value. Default value is "New Tour Configuration"
      See Also:

    • setTourWizardTourTypeTitle

      public Tour setTourWizardTourTypeTitle(String tourWizardTourTypeTitle) throws IllegalStateException
      Title for the Tour Type picker in the Tour Wizard.
      Parameters:
      tourWizardTourTypeTitle - New tourWizardTourTypeTitle value. Default value is "Tour Type"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardTourTypeTitle

      public String getTourWizardTourTypeTitle()
      Title for the Tour Type picker in the Tour Wizard.
      Returns:
      Current tourWizardTourTypeTitle value. Default value is "Tour Type"
      See Also:

    • setTourWizardUITourTitle

      public Tour setTourWizardUITourTitle(String tourWizardUITourTitle) throws IllegalStateException
      Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.
      Parameters:
      tourWizardUITourTitle - New tourWizardUITourTitle value. Default value is "UI Tour (Non Interactive)"
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTourWizardUITourTitle

      public String getTourWizardUITourTitle()
      Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.
      Returns:
      Current tourWizardUITourTitle value. Default value is "UI Tour (Non Interactive)"
      See Also:

    • setWindowDefaults

      public Tour setWindowDefaults(Canvas windowDefaults) throws IllegalStateException
      Defaults for each TourStep.targetView autoChild in the tour. These defaults are applied before TourStep.windowDefaults if any.
      Parameters:
      windowDefaults - New windowDefaults value. Default value is {...}
      Returns:
      Tour instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getWindowDefaults

      public Canvas getWindowDefaults()
      Defaults for each TourStep.targetView autoChild in the tour. These defaults are applied before TourStep.windowDefaults if any.
      Returns:
      Current windowDefaults value. Default value is {...}

    • notifyValidationMessage

      public void notifyValidationMessage(String message)
      Notify user of expected value entry validation message. Default implementation uses the Notify system to show the message in it's default position. See notifyType for notification configuration details.

      Parameters:
      message - message provided by TourStep.inputValidationNotifyMessage

    • getTour

      public static Tour getTour(String tourId)
      Get a Tour instance by it's ID.
      Parameters:
      tourId - tour ID to retrieve. See Identifier
      Returns:
      the tour, or null if not defined
      See Also:

    • loadTour

      public static void loadTour(String tourId, ProcessCallback callback)
      Loads an XML tour definition stored in XML from the server.

      Tour files are stored as .proc.xml files in Component XML format, in the directory indicated by the project.processes setting in server.properties (webroot/processes by default). To load a tour saved in a file tourId.proc.xml, pass just tourId to this method.

      Parameters:
      tourId - tour ID or IDs to load. See Identifier
      callback - called when the tour is loaded with argument "process", the first tour. Other tours can be looked up via getTour().