Class Tour
- All Implemented Interfaces:
HasHandlers,HasFinishedHandlers,HasTraceElementHandlers
- Direct Known Subclasses:
Tutorial
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.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()booleanDefault value forTourStep.allowDropOnDescendantswithin this tour.Should tour be auto-reset once it finishes in any manner so it can restarted?Set tofalseto prevent tour steps from allowing the user to cancel the tour.TheProcessElements representing steps that should be performed if the user cancels the tour.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").Default value ofTourStep.actionButtonTitlefor the first step in the tour.Default value ofTourStep.cancelButtonTitlefor the first step in the tour.Default value ofTourStep.actionButtonTitlefor the last step in the tour.getMode()The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.Defaults settings fornotifyTypemessage displayed bynotifyValidationMessage.Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.static TourgetOrCreateRef(JavaScriptObject jsObj) 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").This property allows you to override theTourWindow.showCancelButtonto hide the cancel button for all steps of the tour.ShouldTourStep.inputValidationNotifyMessagebe shown as detailed inTourInputValidationModefor the entire tour? Set tofalseto suppress reporting messages to the user.Should a progress bar be shown in each step to indicate progress through the tour?Show progress percent next to progress bar whenshowProgressis enabled?Default value forTourStep.actionButtonTitlefor steps other than the first and last ones.Prompt displayed in hover for cancel button.Default value forTourStep.cancelButtonTitlefor all steps where the cancel button is shown.getSteps()TheProcessElements representing steps in this tour.static TourGet a Tour instance by it's ID.Title for the Make Changes... button in the TourComplete dialog.Title for the View XML button in the TourComplete dialog.Title for the Tour Complete dialog displayed after recording a Tour.Title for the Tour ID field in the TourComplete dialog.Title for the View XML button in the TourComplete dialog.Title for the Action Type field in the TourStep Wizard.Prompt for the Auto Complete field in the TourStep Wizard.Title for the Auto Complete field in the TourStep Wizard.Hint for the Bind Output field in the TourStep Wizard.Title for the Bind Output field in the TourStep Wizard.Title for the Case Sensitive field in the TourStep Wizard.Title for the Done button in the TourStep Wizard.Hint for the Drop Target field in the TourStep Wizard.Descriptive text displayed in a popupnotification windowwhen a Drop Target is selected for this TourStep.Prompt for the Drop Target field in the TourStep Wizard.Title for the Drop Target field in the TourStep Wizard.Hint for the Expected Value field in the TourStep Wizard.Title for the Expected Value field in the TourStep Wizard.Title for the Instructions field in the TourStep Wizard.Title for the Next Step button in the TourStep Wizard.Empty message for the grid in the Tour Wizard when no steps are present.Prompt for the Record Step window header in the TourStep Wizard.Title for the Record Tour Step window in the TourStep Wizard.Descriptive text displayed in a popupnotification windowwhen a Target is selected for this TourStep.Prompt for the Target field in the TourStep Wizard.Title for the Target field in the TourStep Wizard.Title for the TourStep Title field in the TourStep Wizard.Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.Title for the Start with New Screen picker in the Tour Wizard.Title for the Record Tour button in the Tour Wizard.Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.Hint text for the Required DataSources item in the Tour Wizard.Title for the Required DataSources item in the Tour Wizard.Title for the Show Progress picker in the Tour Wizard.Title for the Tour Wizard.Title for the Tour Type picker in the Tour Wizard.Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.Defaults for eachTourStep.targetViewautoChild in the tour.static voidloadTour(String tourId, ProcessCallback callback) Loads an XML tour definition stored in XML from the server.voidnotifyValidationMessage(String message) Notify user of expected value entry validation message.setAllowDropOnDescendants(boolean allowDropOnDescendants) Default value forTourStep.allowDropOnDescendantswithin this tour.setAutoReset(Boolean autoReset) Should tour be auto-reset once it finishes in any manner so it can restarted?setCanCancel(Boolean canCancel) Set tofalseto prevent tour steps from allowing the user to cancel the tour.setCancelSteps(ProcessElement... cancelSteps) TheProcessElements representing steps that should be performed if the user cancels the 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").setFirstStepActionButtonTitle(String firstStepActionButtonTitle) Default value ofTourStep.actionButtonTitlefor the first step in the tour.setFirstStepCancelButtonTitle(String firstStepCancelButtonTitle) Default value ofTourStep.cancelButtonTitlefor the first step in the tour.setLastStepActionButtonTitle(String lastStepActionButtonTitle) Default value ofTourStep.actionButtonTitlefor the last step in the tour.The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.setNotifyMessageSettings(NotifySettings notifyMessageSettings) Defaults settings fornotifyTypemessage displayed bynotifyValidationMessage.setNotifyType(String notifyType) Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.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").setShowCancelButton(Boolean showCancelButton) This property allows you to override theTourWindow.showCancelButtonto hide the cancel button for all steps of the tour.setShowInputValidationMessage(Boolean showInputValidationMessage) ShouldTourStep.inputValidationNotifyMessagebe shown as detailed inTourInputValidationModefor the entire tour? Set tofalseto suppress reporting messages to the user.setShowProgress(Boolean showProgress) Should a progress bar be shown in each step to indicate progress through the tour?setShowProgressPercent(Boolean showProgressPercent) Show progress percent next to progress bar whenshowProgressis enabled?setStepActionButtonTitle(String stepActionButtonTitle) Default value forTourStep.actionButtonTitlefor steps other than the first and last ones.setStepCancelButtonPrompt(String stepCancelButtonPrompt) Prompt displayed in hover for cancel button.setStepCancelButtonTitle(String stepCancelButtonTitle) Default value forTourStep.cancelButtonTitlefor all steps where the cancel button is shown.setSteps(ProcessElement... steps) TheProcessElements representing steps in this tour.setTourCompleteMakeChangesButtonTitle(String tourCompleteMakeChangesButtonTitle) Title for the Make Changes... button in the TourComplete dialog.setTourCompleteRunTourButtonTitle(String tourCompleteRunTourButtonTitle) Title for the View XML button in the TourComplete dialog.setTourCompleteTitle(String tourCompleteTitle) Title for the Tour Complete dialog displayed after recording a Tour.setTourCompleteTourIdTitle(String tourCompleteTourIdTitle) Title for the Tour ID field in the TourComplete dialog.setTourCompleteViewXMLButtonTitle(String tourCompleteViewXMLButtonTitle) Title for the View XML button in the TourComplete dialog.setTourStepWizardActionTypeTitle(String tourStepWizardActionTypeTitle) Title for the Action Type field in the TourStep Wizard.setTourStepWizardAutoCompletePrompt(String tourStepWizardAutoCompletePrompt) Prompt for the Auto Complete field in the TourStep Wizard.setTourStepWizardAutoCompleteTitle(String tourStepWizardAutoCompleteTitle) Title for the Auto Complete field in the TourStep Wizard.setTourStepWizardBindOutputHint(String tourStepWizardBindOutputHint) Hint for the Bind Output field in the TourStep Wizard.setTourStepWizardBindOutputTitle(String tourStepWizardBindOutputTitle) Title for the Bind Output field in the TourStep Wizard.setTourStepWizardCaseSensitiveTitle(String tourStepWizardCaseSensitiveTitle) Title for the Case Sensitive field in the TourStep Wizard.setTourStepWizardDoneButtonTitle(String tourStepWizardDoneButtonTitle) Title for the Done button in the TourStep Wizard.setTourStepWizardDropTargetHint(String tourStepWizardDropTargetHint) Hint for the Drop Target field in the TourStep Wizard.setTourStepWizardDropTargetNotifyText(String tourStepWizardDropTargetNotifyText) Descriptive text displayed in a popupnotification windowwhen a Drop Target is selected for this TourStep.setTourStepWizardDropTargetPrompt(String tourStepWizardDropTargetPrompt) Prompt for the Drop Target field in the TourStep Wizard.setTourStepWizardDropTargetTitle(String tourStepWizardDropTargetTitle) Title for the Drop Target field in the TourStep Wizard.setTourStepWizardExpectedValueHint(String tourStepWizardExpectedValueHint) Hint for the Expected Value field in the TourStep Wizard.setTourStepWizardExpectedValueTitle(String tourStepWizardExpectedValueTitle) Title for the Expected Value field in the TourStep Wizard.setTourStepWizardInstructionsTitle(String tourStepWizardInstructionsTitle) Title for the Instructions field in the TourStep Wizard.setTourStepWizardNextStepButtonTitle(String tourStepWizardNextStepButtonTitle) Title for the Next Step button in the TourStep Wizard.setTourStepWizardNoStepsMessage(String tourStepWizardNoStepsMessage) Empty message for the grid in the Tour Wizard when no steps are present.setTourStepWizardRecordStepHeaderPrompt(String tourStepWizardRecordStepHeaderPrompt) Prompt for the Record Step window header in the TourStep Wizard.setTourStepWizardRecordStepTitle(String tourStepWizardRecordStepTitle) Title for the Record Tour Step window in the TourStep Wizard.setTourStepWizardTargeNotifyText(String tourStepWizardTargeNotifyText) Descriptive text displayed in a popupnotification windowwhen a Target is selected for this TourStep.setTourStepWizardTargePrompt(String tourStepWizardTargePrompt) Prompt for the Target field in the TourStep Wizard.setTourStepWizardTargetTitle(String tourStepWizardTargetTitle) Title for the Target field in the TourStep Wizard.setTourStepWizardTitle(String tourStepWizardTitle) Title for the TourStep Title field in the TourStep Wizard.setTourWizardInteractiveTourTitle(String tourWizardInteractiveTourTitle) Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.setTourWizardNewScreenPickerTitle(String tourWizardNewScreenPickerTitle) Title for the Start with New Screen picker in the Tour Wizard.setTourWizardRecordButtonTitle(String tourWizardRecordButtonTitle) Title for the Record Tour button in the Tour Wizard.setTourWizardReifyTourTitle(String tourWizardReifyTourTitle) Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.setTourWizardRequiredDataSourcesHint(String tourWizardRequiredDataSourcesHint) Hint text for the Required DataSources item in the Tour Wizard.setTourWizardRequiredDataSourcesTitle(String tourWizardRequiredDataSourcesTitle) Title for the Required DataSources item in the Tour Wizard.setTourWizardShowProgressTitle(String tourWizardShowProgressTitle) Title for the Show Progress picker in the Tour Wizard.setTourWizardTitle(String tourWizardTitle) Title for the Tour Wizard.setTourWizardTourTypeTitle(String tourWizardTourTypeTitle) Title for the Tour Type picker in the Tour Wizard.setTourWizardUITourTitle(String tourWizardUITourTitle) Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.setWindowDefaults(Canvas windowDefaults) Defaults for eachTourStep.targetViewautoChild in the tour.Methods inherited from class com.smartgwt.client.util.workflow.Process
addFinishedHandler, addTraceElementHandler, getComponentReferences, getContainerId, getDefaultWaitDuration, getDefaultWaitFor, getElement, getElements, getJsObj, getLastTaskOutput, getLastTaskOutput, getMockMode, getOrCreateJsObj, getProcess, getProcessDescription, getProcessElements, getRuleScope, getSequences, getStartElement, getState, getStateVariable, getTraceContext, getWizard, isCreated, loadProcess, onInit, passThruTaskOutput, reset, reset, setAttribute, setConfig, setContainerId, setDefaultWaitDuration, setDefaultWaitFor, setElements, setJavaScriptObject, setMockMode, setNextElement, setNextElement, setRuleScope, setSequences, setStartElement, setStartElement, setState, setStateVariable, setTaskOutput, setTraceContext, setWizard, startMethods inherited from class com.smartgwt.client.core.BaseClass
addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setScClassNameMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
Tour
public Tour() -
Tour
-
-
Method Details
-
getOrCreateRef
-
create
-
setAllowDropOnDescendants
Default value forTourStep.allowDropOnDescendantswithin this tour.- Parameters:
allowDropOnDescendants- New allowDropOnDescendants value. Default value is false- Returns:
Tourinstance, for chaining setter calls
-
getAllowDropOnDescendants
public boolean getAllowDropOnDescendants()Default value forTourStep.allowDropOnDescendantswithin this tour.- Returns:
- Current allowDropOnDescendants value. Default value is false
-
setAutoReset
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
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
Set tofalseto prevent tour steps from allowing the user to cancel the tour. By default the cancel button will still be shown but is disabled. SetshowCancelButtonto false to suppress the cancel button entirely.Any time the cancel button is visible, its hover can be customized via
stepCancelButtonPrompt. ForcanCancel:falsetours 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCanCancel
Set tofalseto prevent tour steps from allowing the user to cancel the tour. By default the cancel button will still be shown but is disabled. SetshowCancelButtonto false to suppress the cancel button entirely.Any time the cancel button is visible, its hover can be customized via
stepCancelButtonPrompt. ForcanCancel:falsetours 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
TheProcessElements representing steps that should be performed if the user cancels the tour. These steps are typicallyTourSteps.Alternately, or in addition to these cancelation steps, the
finishedmethod will be called once there are no more steps to process in the tour.- Parameters:
cancelSteps- New cancelSteps value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getCancelSteps
TheProcessElements representing steps that should be performed if the user cancels the tour. These steps are typicallyTourSteps.Alternately, or in addition to these cancelation steps, the
finishedmethod will be called once there are no more steps to process in the tour.- Returns:
- Current cancelSteps value. Default value is null
-
setDropOutlineBorder
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"). SeeoutlineBorderfor 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:
Tourinstance, for chaining setter calls- See Also:
-
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"). SeeoutlineBorderfor 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 ofTourStep.actionButtonTitlefor the first step in the tour.Default titles for the middle and last steps are configured by
stepActionButtonTitleandlastStepActionButtonTitlerespectively.- Parameters:
firstStepActionButtonTitle- New firstStepActionButtonTitle value. Default value is "Let's go!"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getFirstStepActionButtonTitle
Default value ofTourStep.actionButtonTitlefor the first step in the tour.Default titles for the middle and last steps are configured by
stepActionButtonTitleandlastStepActionButtonTitlerespectively.- Returns:
- Current firstStepActionButtonTitle value. Default value is "Let's go!"
- See Also:
-
setFirstStepCancelButtonTitle
public Tour setFirstStepCancelButtonTitle(String firstStepCancelButtonTitle) throws IllegalStateException Default value ofTourStep.cancelButtonTitlefor 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getFirstStepCancelButtonTitle
Default value ofTourStep.cancelButtonTitlefor 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 ofTourStep.actionButtonTitlefor the last step in the tour.Default titles for the first and middle steps are configured by
firstStepActionButtonTitleandstepActionButtonTitlerespectively.- Parameters:
lastStepActionButtonTitle- New lastStepActionButtonTitle value. Default value is "Done"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getLastStepActionButtonTitle
Default value ofTourStep.actionButtonTitlefor the last step in the tour.Default titles for the first and middle steps are configured by
firstStepActionButtonTitleandstepActionButtonTitlerespectively.- Returns:
- Current lastStepActionButtonTitle value. Default value is "Done"
- See Also:
-
setMode
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:
Tourinstance, for chaining setter calls
-
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 fornotifyTypemessage displayed bynotifyValidationMessage.- Parameters:
notifyMessageSettings- New notifyMessageSettings value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getNotifyMessageSettings
Defaults settings fornotifyTypemessage displayed bynotifyValidationMessage.- Returns:
- Current notifyMessageSettings value. Default value is null
-
setNotifyType
Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.If this category has not been configured in
Notifyit will be automatically configured using +{notifyMessageSettings,notifyMessageSettings}.- Parameters:
notifyType- New notifyType value. Default value is "tourExpectedValue"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getNotifyType
Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.If this category has not been configured in
Notifyit will be automatically configured using +{notifyMessageSettings,notifyMessageSettings}.- Returns:
- Current notifyType value. Default value is "tourExpectedValue"
- See Also:
-
setOutlineBorder
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"). SeedropOutlineBorderfor 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:
Tourinstance, for chaining setter calls- See Also:
-
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"). SeedropOutlineBorderfor 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
This property allows you to override theTourWindow.showCancelButtonto hide the cancel button for all steps of the tour.See also
canCancel- Parameters:
showCancelButton- New showCancelButton value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowCancelButton
This property allows you to override theTourWindow.showCancelButtonto 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 ShouldTourStep.inputValidationNotifyMessagebe shown as detailed inTourInputValidationModefor the entire tour? Set tofalseto suppress reporting messages to the user.notifyValidationMessagewill not be called.This setting can be overridden for individual
tourSteps.- Parameters:
showInputValidationMessage- New showInputValidationMessage value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowInputValidationMessage
ShouldTourStep.inputValidationNotifyMessagebe shown as detailed inTourInputValidationModefor the entire tour? Set tofalseto suppress reporting messages to the user.notifyValidationMessagewill not be called.This setting can be overridden for individual
tourSteps.- Returns:
- Current showInputValidationMessage value. Default value is null
-
setShowProgress
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
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
Show progress percent next to progress bar whenshowProgressis enabled?- Parameters:
showProgressPercent- New showProgressPercent value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowProgressPercent
Show progress percent next to progress bar whenshowProgressis enabled?- Returns:
- Current showProgressPercent value. Default value is null
-
setStepActionButtonTitle
Default value forTourStep.actionButtonTitlefor steps other than the first and last ones.Default titles for the first and last steps are configured by
firstStepActionButtonTitleandlastStepActionButtonTitlerespectively.- Parameters:
stepActionButtonTitle- New stepActionButtonTitle value. Default value is "Next"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getStepActionButtonTitle
Default value forTourStep.actionButtonTitlefor steps other than the first and last ones.Default titles for the first and last steps are configured by
firstStepActionButtonTitleandlastStepActionButtonTitlerespectively.- Returns:
- Current stepActionButtonTitle value. Default value is "Next"
- See Also:
-
setStepCancelButtonPrompt
Prompt displayed in hover for cancel button.- Parameters:
stepCancelButtonPrompt- New stepCancelButtonPrompt value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getStepCancelButtonPrompt
Prompt displayed in hover for cancel button.- Returns:
- Current stepCancelButtonPrompt value. Default value is null
- See Also:
-
setStepCancelButtonTitle
Default value forTourStep.cancelButtonTitlefor 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getStepCancelButtonTitle
Default value forTourStep.cancelButtonTitlefor 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
TheProcessElements representing steps in this tour. These steps are typicallyTourSteps.- Parameters:
steps- New steps value. Default value is null- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getSteps
TheProcessElements representing steps in this tour. These steps are typicallyTourSteps.- 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourCompleteRunTourButtonTitle
Title for the View XML button in the TourComplete dialog.- Returns:
- Current tourCompleteRunTourButtonTitle value. Default value is "Run Tour"
- See Also:
-
setTourCompleteTitle
Title for the Tour Complete dialog displayed after recording a Tour.- Parameters:
tourCompleteTitle- New tourCompleteTitle value. Default value is "New Tour Recording Complete"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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
Title for the Tour ID field in the TourComplete dialog.- Parameters:
tourCompleteTourIdTitle- New tourCompleteTourIdTitle value. Default value is "Tour ID"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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 popupnotification windowwhen 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourStepWizardDropTargetNotifyText
Descriptive text displayed in a popupnotification windowwhen 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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 popupnotification windowwhen 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourStepWizardTargeNotifyText
Descriptive text displayed in a popupnotification windowwhen 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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourStepWizardTargetTitle
Title for the Target field in the TourStep Wizard.- Returns:
- Current tourStepWizardTargetTitle value. Default value is "Target"
- See Also:
-
setTourStepWizardTitle
Title for the TourStep Title field in the TourStep Wizard.- Parameters:
tourStepWizardTitle- New tourStepWizardTitle value. Default value is "Title"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourWizardShowProgressTitle
Title for the Show Progress picker in the Tour Wizard.- Returns:
- Current tourWizardShowProgressTitle value. Default value is "Show Progress"
- See Also:
-
setTourWizardTitle
Title for the Tour Wizard.- Parameters:
tourWizardTitle- New tourWizardTitle value. Default value is "New Tour Configuration"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourWizardTitle
Title for the Tour Wizard.- Returns:
- Current tourWizardTitle value. Default value is "New Tour Configuration"
- See Also:
-
setTourWizardTourTypeTitle
Title for the Tour Type picker in the Tour Wizard.- Parameters:
tourWizardTourTypeTitle- New tourWizardTourTypeTitle value. Default value is "Tour Type"- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTourWizardTourTypeTitle
Title for the Tour Type picker in the Tour Wizard.- Returns:
- Current tourWizardTourTypeTitle value. Default value is "Tour Type"
- See Also:
-
setTourWizardUITourTitle
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:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
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
Defaults for eachTourStep.targetViewautoChild in the tour. These defaults are applied beforeTourStep.windowDefaultsif any.- Parameters:
windowDefaults- New windowDefaults value. Default value is {...}- Returns:
Tourinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getWindowDefaults
Defaults for eachTourStep.targetViewautoChild in the tour. These defaults are applied beforeTourStep.windowDefaultsif any.- Returns:
- Current windowDefaults value. Default value is {...}
-
notifyValidationMessage
Notify user of expected value entry validation message. Default implementation uses theNotify systemto show the message in it's default position. SeenotifyTypefor notification configuration details.- Parameters:
message- message provided byTourStep.inputValidationNotifyMessage
-
getTour
Get a Tour instance by it's ID.- Parameters:
tourId- tour ID to retrieve. SeeIdentifier- Returns:
- the tour, or null if not defined
- See Also:
-
loadTour
Loads an XML tour definition stored in XML from the server.Tour files are stored as .proc.xml files in
Component XMLformat, in the directory indicated by theproject.processessetting inserver.properties(webroot/processesby 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. SeeIdentifiercallback- called when the tour is loaded with argument "process", the first tour. Other tours can be looked up viagetTour().
-