public class Tour extends Process
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.
config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
Tour() |
Tour(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
boolean |
getAllowDropOnDescendants()
Default value for
TourStep.allowDropOnDescendants within this tour. |
java.lang.Boolean |
getAutoReset()
Should tour be auto-reset once it finishes in any manner so it can restarted?
|
java.lang.Boolean |
getCanCancel()
Set to
false to prevent tour steps from allowing the user to cancel the tour. |
ProcessElement[] |
getCancelSteps()
The
ProcessElements representing steps that should be performed if the user
cancels the tour. |
java.lang.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").
|
java.lang.String |
getFirstStepActionButtonTitle()
Default value of
TourStep.actionButtonTitle for the
first step in the tour. |
java.lang.String |
getFirstStepCancelButtonTitle()
Default value of
TourStep.cancelButtonTitle for the
first step in the tour. |
java.lang.String |
getLastStepActionButtonTitle()
Default value of
TourStep.actionButtonTitle for the
last step in the tour. |
TourMode |
getMode()
The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.
|
NotifySettings |
getNotifyMessageSettings()
Defaults settings for
notifyType message displayed by notifyValidationMessage. |
java.lang.String |
getNotifyType()
Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.
|
static Tour |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.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").
|
java.lang.Boolean |
getShowCancelButton()
This property allows you to override the
TourWindow.showCancelButton to hide the cancel button for all steps of the tour. |
java.lang.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. |
java.lang.Boolean |
getShowProgress()
Should a progress bar be shown in each step to indicate progress through the tour?
|
java.lang.Boolean |
getShowProgressPercent()
Show progress percent next to progress bar when
showProgress
is enabled? |
java.lang.String |
getStepActionButtonTitle()
Default value for
TourStep.actionButtonTitle for
steps other than the first and last ones. |
java.lang.String |
getStepCancelButtonPrompt()
Prompt displayed in hover for cancel button.
|
java.lang.String |
getStepCancelButtonTitle()
Default value for
TourStep.cancelButtonTitle for all
steps where the cancel button is shown. |
ProcessElement[] |
getSteps()
The
ProcessElements representing steps in this tour. |
static Tour |
getTour(java.lang.String tourId)
Get a Tour instance by it's ID.
|
java.lang.String |
getTourCompleteMakeChangesButtonTitle()
Title for the Make Changes... button in the TourComplete dialog.
|
java.lang.String |
getTourCompleteRunTourButtonTitle()
Title for the View XML button in the TourComplete dialog.
|
java.lang.String |
getTourCompleteTitle()
Title for the Tour Complete dialog displayed after recording a Tour.
|
java.lang.String |
getTourCompleteTourIdTitle()
Title for the Tour ID field in the TourComplete dialog.
|
java.lang.String |
getTourCompleteViewXMLButtonTitle()
Title for the View XML button in the TourComplete dialog.
|
java.lang.String |
getTourStepWizardActionTypeTitle()
Title for the Action Type field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardAutoCompletePrompt()
Prompt for the Auto Complete field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardAutoCompleteTitle()
Title for the Auto Complete field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardBindOutputHint()
Hint for the Bind Output field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardBindOutputTitle()
Title for the Bind Output field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardCaseSensitiveTitle()
Title for the Case Sensitive field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardDoneButtonTitle()
Title for the Done button in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardDropTargetHint()
Hint for the Drop Target field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardDropTargetNotifyText()
Descriptive text displayed in a popup
notification window when a
Drop Target is selected for this TourStep. |
java.lang.String |
getTourStepWizardDropTargetPrompt()
Prompt for the Drop Target field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardDropTargetTitle()
Title for the Drop Target field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardExpectedValueHint()
Hint for the Expected Value field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardExpectedValueTitle()
Title for the Expected Value field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardInstructionsTitle()
Title for the Instructions field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardNextStepButtonTitle()
Title for the Next Step button in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardNoStepsMessage()
Empty message for the grid in the Tour Wizard when no steps are present.
|
java.lang.String |
getTourStepWizardRecordStepHeaderPrompt()
Prompt for the Record Step window header in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardRecordStepTitle()
Title for the Record Tour Step window in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardTargeNotifyText()
Descriptive text displayed in a popup
notification window when a
Target is selected for this TourStep. |
java.lang.String |
getTourStepWizardTargePrompt()
Prompt for the Target field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardTargetTitle()
Title for the Target field in the TourStep Wizard.
|
java.lang.String |
getTourStepWizardTitle()
Title for the TourStep Title field in the TourStep Wizard.
|
java.lang.String |
getTourWizardInteractiveTourTitle()
Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.
|
java.lang.String |
getTourWizardNewScreenPickerTitle()
Title for the Start with New Screen picker in the Tour Wizard.
|
java.lang.String |
getTourWizardRecordButtonTitle()
Title for the Record Tour button in the Tour Wizard.
|
java.lang.String |
getTourWizardReifyTourTitle()
Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.
|
java.lang.String |
getTourWizardRequiredDataSourcesHint()
Hint text for the Required DataSources item in the Tour Wizard.
|
java.lang.String |
getTourWizardRequiredDataSourcesTitle()
Title for the Required DataSources item in the Tour Wizard.
|
java.lang.String |
getTourWizardShowProgressTitle()
Title for the Show Progress picker in the Tour Wizard.
|
java.lang.String |
getTourWizardTitle()
Title for the Tour Wizard.
|
java.lang.String |
getTourWizardTourTypeTitle()
Title for the Tour Type picker in the Tour Wizard.
|
java.lang.String |
getTourWizardUITourTitle()
Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.
|
Canvas |
getWindowDefaults()
Defaults for each
TourStep.targetView autoChild in the
tour. |
static void |
loadTour(java.lang.String tourId,
ProcessCallback callback)
Loads an XML tour definition stored in XML from the server.
|
void |
notifyValidationMessage(java.lang.String message)
Notify user of expected value entry validation message.
|
Tour |
setAllowDropOnDescendants(boolean allowDropOnDescendants)
Default value for
TourStep.allowDropOnDescendants within this tour. |
Tour |
setAutoReset(java.lang.Boolean autoReset)
Should tour be auto-reset once it finishes in any manner so it can restarted?
|
Tour |
setCanCancel(java.lang.Boolean canCancel)
Set to
false to prevent tour steps from allowing the user to cancel the tour. |
Tour |
setCancelSteps(ProcessElement... cancelSteps)
The
ProcessElements representing steps that should be performed if the user
cancels the tour. |
Tour |
setDropOutlineBorder(java.lang.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").
|
Tour |
setFirstStepActionButtonTitle(java.lang.String firstStepActionButtonTitle)
Default value of
TourStep.actionButtonTitle for the
first step in the tour. |
Tour |
setFirstStepCancelButtonTitle(java.lang.String firstStepCancelButtonTitle)
Default value of
TourStep.cancelButtonTitle for the
first step in the tour. |
Tour |
setLastStepActionButtonTitle(java.lang.String lastStepActionButtonTitle)
Default value of
TourStep.actionButtonTitle for the
last step in the tour. |
Tour |
setMode(TourMode mode)
The tour mode allows step configuration to be simplified by using the context to apply appropriate defaults.
|
Tour |
setNotifyMessageSettings(NotifySettings notifyMessageSettings)
Defaults settings for
notifyType message displayed by notifyValidationMessage. |
Tour |
setNotifyType(java.lang.String notifyType)
Category of message to use in +{notifyValidationMessage,notifyValidationMessage} by default.
|
Tour |
setOutlineBorder(java.lang.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").
|
Tour |
setShowCancelButton(java.lang.Boolean showCancelButton)
This property allows you to override the
TourWindow.showCancelButton to hide the cancel button for all steps of the tour. |
Tour |
setShowInputValidationMessage(java.lang.Boolean showInputValidationMessage)
Should
TourStep.inputValidationNotifyMessage be shown as detailed in TourInputValidationMode
for the entire tour? Set to false to suppress reporting messages to the user. |
Tour |
setShowProgress(java.lang.Boolean showProgress)
Should a progress bar be shown in each step to indicate progress through the tour?
|
Tour |
setShowProgressPercent(java.lang.Boolean showProgressPercent)
Show progress percent next to progress bar when
showProgress
is enabled? |
Tour |
setStepActionButtonTitle(java.lang.String stepActionButtonTitle)
Default value for
TourStep.actionButtonTitle for
steps other than the first and last ones. |
Tour |
setStepCancelButtonPrompt(java.lang.String stepCancelButtonPrompt)
Prompt displayed in hover for cancel button.
|
Tour |
setStepCancelButtonTitle(java.lang.String stepCancelButtonTitle)
Default value for
TourStep.cancelButtonTitle for all
steps where the cancel button is shown. |
Tour |
setSteps(ProcessElement... steps)
The
ProcessElements representing steps in this tour. |
Tour |
setTourCompleteMakeChangesButtonTitle(java.lang.String tourCompleteMakeChangesButtonTitle)
Title for the Make Changes... button in the TourComplete dialog.
|
Tour |
setTourCompleteRunTourButtonTitle(java.lang.String tourCompleteRunTourButtonTitle)
Title for the View XML button in the TourComplete dialog.
|
Tour |
setTourCompleteTitle(java.lang.String tourCompleteTitle)
Title for the Tour Complete dialog displayed after recording a Tour.
|
Tour |
setTourCompleteTourIdTitle(java.lang.String tourCompleteTourIdTitle)
Title for the Tour ID field in the TourComplete dialog.
|
Tour |
setTourCompleteViewXMLButtonTitle(java.lang.String tourCompleteViewXMLButtonTitle)
Title for the View XML button in the TourComplete dialog.
|
Tour |
setTourStepWizardActionTypeTitle(java.lang.String tourStepWizardActionTypeTitle)
Title for the Action Type field in the TourStep Wizard.
|
Tour |
setTourStepWizardAutoCompletePrompt(java.lang.String tourStepWizardAutoCompletePrompt)
Prompt for the Auto Complete field in the TourStep Wizard.
|
Tour |
setTourStepWizardAutoCompleteTitle(java.lang.String tourStepWizardAutoCompleteTitle)
Title for the Auto Complete field in the TourStep Wizard.
|
Tour |
setTourStepWizardBindOutputHint(java.lang.String tourStepWizardBindOutputHint)
Hint for the Bind Output field in the TourStep Wizard.
|
Tour |
setTourStepWizardBindOutputTitle(java.lang.String tourStepWizardBindOutputTitle)
Title for the Bind Output field in the TourStep Wizard.
|
Tour |
setTourStepWizardCaseSensitiveTitle(java.lang.String tourStepWizardCaseSensitiveTitle)
Title for the Case Sensitive field in the TourStep Wizard.
|
Tour |
setTourStepWizardDoneButtonTitle(java.lang.String tourStepWizardDoneButtonTitle)
Title for the Done button in the TourStep Wizard.
|
Tour |
setTourStepWizardDropTargetHint(java.lang.String tourStepWizardDropTargetHint)
Hint for the Drop Target field in the TourStep Wizard.
|
Tour |
setTourStepWizardDropTargetNotifyText(java.lang.String tourStepWizardDropTargetNotifyText)
Descriptive text displayed in a popup
notification window when a
Drop Target is selected for this TourStep. |
Tour |
setTourStepWizardDropTargetPrompt(java.lang.String tourStepWizardDropTargetPrompt)
Prompt for the Drop Target field in the TourStep Wizard.
|
Tour |
setTourStepWizardDropTargetTitle(java.lang.String tourStepWizardDropTargetTitle)
Title for the Drop Target field in the TourStep Wizard.
|
Tour |
setTourStepWizardExpectedValueHint(java.lang.String tourStepWizardExpectedValueHint)
Hint for the Expected Value field in the TourStep Wizard.
|
Tour |
setTourStepWizardExpectedValueTitle(java.lang.String tourStepWizardExpectedValueTitle)
Title for the Expected Value field in the TourStep Wizard.
|
Tour |
setTourStepWizardInstructionsTitle(java.lang.String tourStepWizardInstructionsTitle)
Title for the Instructions field in the TourStep Wizard.
|
Tour |
setTourStepWizardNextStepButtonTitle(java.lang.String tourStepWizardNextStepButtonTitle)
Title for the Next Step button in the TourStep Wizard.
|
Tour |
setTourStepWizardNoStepsMessage(java.lang.String tourStepWizardNoStepsMessage)
Empty message for the grid in the Tour Wizard when no steps are present.
|
Tour |
setTourStepWizardRecordStepHeaderPrompt(java.lang.String tourStepWizardRecordStepHeaderPrompt)
Prompt for the Record Step window header in the TourStep Wizard.
|
Tour |
setTourStepWizardRecordStepTitle(java.lang.String tourStepWizardRecordStepTitle)
Title for the Record Tour Step window in the TourStep Wizard.
|
Tour |
setTourStepWizardTargeNotifyText(java.lang.String tourStepWizardTargeNotifyText)
Descriptive text displayed in a popup
notification window when a
Target is selected for this TourStep. |
Tour |
setTourStepWizardTargePrompt(java.lang.String tourStepWizardTargePrompt)
Prompt for the Target field in the TourStep Wizard.
|
Tour |
setTourStepWizardTargetTitle(java.lang.String tourStepWizardTargetTitle)
Title for the Target field in the TourStep Wizard.
|
Tour |
setTourStepWizardTitle(java.lang.String tourStepWizardTitle)
Title for the TourStep Title field in the TourStep Wizard.
|
Tour |
setTourWizardInteractiveTourTitle(java.lang.String tourWizardInteractiveTourTitle)
Title for the interactive Tutorial option in the Tour Type picker in the Tour Wizard.
|
Tour |
setTourWizardNewScreenPickerTitle(java.lang.String tourWizardNewScreenPickerTitle)
Title for the Start with New Screen picker in the Tour Wizard.
|
Tour |
setTourWizardRecordButtonTitle(java.lang.String tourWizardRecordButtonTitle)
Title for the Record Tour button in the Tour Wizard.
|
Tour |
setTourWizardReifyTourTitle(java.lang.String tourWizardReifyTourTitle)
Title for the Reify Tutorial option in the Tour Type picker in the Tour Wizard.
|
Tour |
setTourWizardRequiredDataSourcesHint(java.lang.String tourWizardRequiredDataSourcesHint)
Hint text for the Required DataSources item in the Tour Wizard.
|
Tour |
setTourWizardRequiredDataSourcesTitle(java.lang.String tourWizardRequiredDataSourcesTitle)
Title for the Required DataSources item in the Tour Wizard.
|
Tour |
setTourWizardShowProgressTitle(java.lang.String tourWizardShowProgressTitle)
Title for the Show Progress picker in the Tour Wizard.
|
Tour |
setTourWizardTitle(java.lang.String tourWizardTitle)
Title for the Tour Wizard.
|
Tour |
setTourWizardTourTypeTitle(java.lang.String tourWizardTourTypeTitle)
Title for the Tour Type picker in the Tour Wizard.
|
Tour |
setTourWizardUITourTitle(java.lang.String tourWizardUITourTitle)
Title for the non-interactive UI Tour option in the Tour Type picker in the Tour Wizard.
|
Tour |
setWindowDefaults(Canvas windowDefaults)
Defaults for each
TourStep.targetView autoChild in the
tour. |
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, startaddDynamicProperty, 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, setScClassNamepublic Tour()
public Tour(com.google.gwt.core.client.JavaScriptObject jsObj)
public static Tour getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
public Tour setAllowDropOnDescendants(boolean allowDropOnDescendants)
TourStep.allowDropOnDescendants within this tour.allowDropOnDescendants - New allowDropOnDescendants value. Default value is falseTour instance, for chaining setter callspublic boolean getAllowDropOnDescendants()
TourStep.allowDropOnDescendants within this tour.public Tour setAutoReset(java.lang.Boolean autoReset) throws java.lang.IllegalStateException
autoReset - New autoReset value. Default value is trueTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getAutoReset()
public Tour setCanCancel(java.lang.Boolean canCancel) throws java.lang.IllegalStateException
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.
canCancel - New canCancel value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getCanCancel()
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.
public Tour setCancelSteps(ProcessElement... cancelSteps) throws java.lang.IllegalStateException
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.
cancelSteps - New cancelSteps value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic ProcessElement[] getCancelSteps()
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.
public Tour setDropOutlineBorder(java.lang.String dropOutlineBorder)
outlineBorder for properties
applied to non-drop targets. This property applies the same border to all four sides of the outlined component(s).
dropOutlineBorder - New dropOutlineBorder value. Default value is "1px solid #44ff44"Tour instance, for chaining setter callssetOutlineBorder(java.lang.String)public java.lang.String getDropOutlineBorder()
outlineBorder for properties
applied to non-drop targets. This property applies the same border to all four sides of the outlined component(s).
getOutlineBorder()public Tour setFirstStepActionButtonTitle(java.lang.String firstStepActionButtonTitle) throws java.lang.IllegalStateException
TourStep.actionButtonTitle for the
first step in the tour. Default titles for the middle and last steps are configured by stepActionButtonTitle and lastStepActionButtonTitle respectively.
firstStepActionButtonTitle - New firstStepActionButtonTitle value. Default value is "Let's go!"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getFirstStepActionButtonTitle()
TourStep.actionButtonTitle for the
first step in the tour. Default titles for the middle and last steps are configured by stepActionButtonTitle and lastStepActionButtonTitle respectively.
HTMLStringpublic Tour setFirstStepCancelButtonTitle(java.lang.String firstStepCancelButtonTitle) throws java.lang.IllegalStateException
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.
firstStepCancelButtonTitle - New firstStepCancelButtonTitle value. Default value is "Skip this tour"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getFirstStepCancelButtonTitle()
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.
HTMLStringpublic Tour setLastStepActionButtonTitle(java.lang.String lastStepActionButtonTitle) throws java.lang.IllegalStateException
TourStep.actionButtonTitle for the
last step in the tour. Default titles for the first and middle steps are configured by firstStepActionButtonTitle and stepActionButtonTitle respectively.
lastStepActionButtonTitle - New lastStepActionButtonTitle value. Default value is "Done"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getLastStepActionButtonTitle()
TourStep.actionButtonTitle for the
last step in the tour. Default titles for the first and middle steps are configured by firstStepActionButtonTitle and stepActionButtonTitle respectively.
HTMLStringpublic Tour setMode(TourMode mode)
mode - New mode value. Default value is "tour"Tour instance, for chaining setter callspublic TourMode getMode()
public Tour setNotifyMessageSettings(NotifySettings notifyMessageSettings) throws java.lang.IllegalStateException
notifyType message displayed by notifyValidationMessage.notifyMessageSettings - New notifyMessageSettings value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic NotifySettings getNotifyMessageSettings()
notifyType message displayed by notifyValidationMessage.public Tour setNotifyType(java.lang.String notifyType) throws java.lang.IllegalStateException
If this category has
not been configured in Notify it will be automatically configured using
+{notifyMessageSettings,notifyMessageSettings}.
notifyType - New notifyType value. Default value is "tourExpectedValue"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdNotifyTypepublic java.lang.String getNotifyType()
If this category has
not been configured in Notify it will be automatically configured using
+{notifyMessageSettings,notifyMessageSettings}.
NotifyTypepublic Tour setOutlineBorder(java.lang.String outlineBorder)
dropOutlineBorder for
properties applied to drop targets. This property applies the same border to all four sides of the outlined component(s).
outlineBorder - New outlineBorder value. Default value is "1px solid red"Tour instance, for chaining setter callssetDropOutlineBorder(java.lang.String)public java.lang.String getOutlineBorder()
dropOutlineBorder for
properties applied to drop targets. This property applies the same border to all four sides of the outlined component(s).
getDropOutlineBorder()public Tour setShowCancelButton(java.lang.Boolean showCancelButton) throws java.lang.IllegalStateException
TourWindow.showCancelButton to hide the cancel button for all steps of the tour. See also canCancel
showCancelButton - New showCancelButton value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowCancelButton()
TourWindow.showCancelButton to hide the cancel button for all steps of the tour. See also canCancel
public Tour setShowInputValidationMessage(java.lang.Boolean showInputValidationMessage) throws java.lang.IllegalStateException
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.
showInputValidationMessage - New showInputValidationMessage value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowInputValidationMessage()
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.
public Tour setShowProgress(java.lang.Boolean showProgress) throws java.lang.IllegalStateException
showProgress - New showProgress value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowProgress()
public Tour setShowProgressPercent(java.lang.Boolean showProgressPercent) throws java.lang.IllegalStateException
showProgress
is enabled?showProgressPercent - New showProgressPercent value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowProgressPercent()
showProgress
is enabled?public Tour setStepActionButtonTitle(java.lang.String stepActionButtonTitle) throws java.lang.IllegalStateException
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.
stepActionButtonTitle - New stepActionButtonTitle value. Default value is "Next"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdsetStepCancelButtonTitle(java.lang.String),
HTMLStringpublic java.lang.String getStepActionButtonTitle()
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.
getStepCancelButtonTitle(),
HTMLStringpublic Tour setStepCancelButtonPrompt(java.lang.String stepCancelButtonPrompt) throws java.lang.IllegalStateException
stepCancelButtonPrompt - New stepCancelButtonPrompt value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getStepCancelButtonPrompt()
HTMLStringpublic Tour setStepCancelButtonTitle(java.lang.String stepCancelButtonTitle) throws java.lang.IllegalStateException
TourStep.cancelButtonTitle for all
steps where the cancel button is shown. Default title for the first step is configured by firstStepCancelButtonTitle.
stepCancelButtonTitle - New stepCancelButtonTitle value. Default value is "Skip this tour"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdsetStepActionButtonTitle(java.lang.String),
HTMLStringpublic java.lang.String getStepCancelButtonTitle()
TourStep.cancelButtonTitle for all
steps where the cancel button is shown. Default title for the first step is configured by firstStepCancelButtonTitle.
getStepActionButtonTitle(),
HTMLStringpublic Tour setSteps(ProcessElement... steps) throws java.lang.IllegalStateException
ProcessElements representing steps in this tour. These steps are typically
TourSteps.steps - New steps value. Default value is nullTour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic ProcessElement[] getSteps()
ProcessElements representing steps in this tour. These steps are typically
TourSteps.public Tour setTourCompleteMakeChangesButtonTitle(java.lang.String tourCompleteMakeChangesButtonTitle) throws java.lang.IllegalStateException
tourCompleteMakeChangesButtonTitle - New tourCompleteMakeChangesButtonTitle value. Default value is "Make Changes..."Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourCompleteMakeChangesButtonTitle()
HTMLStringpublic Tour setTourCompleteRunTourButtonTitle(java.lang.String tourCompleteRunTourButtonTitle) throws java.lang.IllegalStateException
tourCompleteRunTourButtonTitle - New tourCompleteRunTourButtonTitle value. Default value is "Run Tour"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourCompleteRunTourButtonTitle()
HTMLStringpublic Tour setTourCompleteTitle(java.lang.String tourCompleteTitle) throws java.lang.IllegalStateException
tourCompleteTitle - New tourCompleteTitle value. Default value is "New Tour Recording Complete"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourCompleteTitle()
HTMLStringpublic Tour setTourCompleteTourIdTitle(java.lang.String tourCompleteTourIdTitle) throws java.lang.IllegalStateException
tourCompleteTourIdTitle - New tourCompleteTourIdTitle value. Default value is "Tour ID"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourCompleteTourIdTitle()
HTMLStringpublic Tour setTourCompleteViewXMLButtonTitle(java.lang.String tourCompleteViewXMLButtonTitle) throws java.lang.IllegalStateException
tourCompleteViewXMLButtonTitle - New tourCompleteViewXMLButtonTitle value. Default value is "View XML"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourCompleteViewXMLButtonTitle()
HTMLStringpublic Tour setTourStepWizardActionTypeTitle(java.lang.String tourStepWizardActionTypeTitle) throws java.lang.IllegalStateException
tourStepWizardActionTypeTitle - New tourStepWizardActionTypeTitle value. Default value is "Action Type"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardActionTypeTitle()
HTMLStringpublic Tour setTourStepWizardAutoCompletePrompt(java.lang.String tourStepWizardAutoCompletePrompt) throws java.lang.IllegalStateException
tourStepWizardAutoCompletePrompt - New tourStepWizardAutoCompletePrompt value. Default value is "Should the tour move forward when the user completes the chosen action?"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardAutoCompletePrompt()
HTMLStringpublic Tour setTourStepWizardAutoCompleteTitle(java.lang.String tourStepWizardAutoCompleteTitle) throws java.lang.IllegalStateException
tourStepWizardAutoCompleteTitle - New tourStepWizardAutoCompleteTitle value. Default value is "Auto Complete"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardAutoCompleteTitle()
HTMLStringpublic Tour setTourStepWizardBindOutputHint(java.lang.String tourStepWizardBindOutputHint) throws java.lang.IllegalStateException
tourStepWizardBindOutputHint - New tourStepWizardBindOutputHint value. Default value is "Bind to variable for later use"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardBindOutputHint()
HTMLStringpublic Tour setTourStepWizardBindOutputTitle(java.lang.String tourStepWizardBindOutputTitle) throws java.lang.IllegalStateException
tourStepWizardBindOutputTitle - New tourStepWizardBindOutputTitle value. Default value is "Bind Output"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardBindOutputTitle()
HTMLStringpublic Tour setTourStepWizardCaseSensitiveTitle(java.lang.String tourStepWizardCaseSensitiveTitle) throws java.lang.IllegalStateException
tourStepWizardCaseSensitiveTitle - New tourStepWizardCaseSensitiveTitle value. Default value is "Case Sensitive"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardCaseSensitiveTitle()
HTMLStringpublic Tour setTourStepWizardDoneButtonTitle(java.lang.String tourStepWizardDoneButtonTitle) throws java.lang.IllegalStateException
tourStepWizardDoneButtonTitle - New tourStepWizardDoneButtonTitle value. Default value is "Done"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardDoneButtonTitle()
HTMLStringpublic Tour setTourStepWizardDropTargetHint(java.lang.String tourStepWizardDropTargetHint) throws java.lang.IllegalStateException
tourStepWizardDropTargetHint - New tourStepWizardDropTargetHint value. Default value is "No drop target"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardDropTargetHint()
HTMLStringpublic Tour setTourStepWizardDropTargetNotifyText(java.lang.String tourStepWizardDropTargetNotifyText) throws java.lang.IllegalStateException
notification window when a
Drop Target is selected for this TourStep.tourStepWizardDropTargetNotifyText - New tourStepWizardDropTargetNotifyText value. Default value is "Shift+Click on the app to record a drop target locator"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardDropTargetNotifyText()
notification window when a
Drop Target is selected for this TourStep.HTMLStringpublic Tour setTourStepWizardDropTargetPrompt(java.lang.String tourStepWizardDropTargetPrompt) throws java.lang.IllegalStateException
tourStepWizardDropTargetPrompt - New tourStepWizardDropTargetPrompt value. Default value is "Click icon, then Shift+Click within the application to add a drop target"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardDropTargetPrompt()
HTMLStringpublic Tour setTourStepWizardDropTargetTitle(java.lang.String tourStepWizardDropTargetTitle) throws java.lang.IllegalStateException
tourStepWizardDropTargetTitle - New tourStepWizardDropTargetTitle value. Default value is "Drop Target"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardDropTargetTitle()
HTMLStringpublic Tour setTourStepWizardExpectedValueHint(java.lang.String tourStepWizardExpectedValueHint) throws java.lang.IllegalStateException
tourStepWizardExpectedValueHint - New tourStepWizardExpectedValueHint value. Default value is "Value for the user to enter"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardExpectedValueHint()
HTMLStringpublic Tour setTourStepWizardExpectedValueTitle(java.lang.String tourStepWizardExpectedValueTitle) throws java.lang.IllegalStateException
tourStepWizardExpectedValueTitle - New tourStepWizardExpectedValueTitle value. Default value is "Expected Value"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardExpectedValueTitle()
HTMLStringpublic Tour setTourStepWizardInstructionsTitle(java.lang.String tourStepWizardInstructionsTitle) throws java.lang.IllegalStateException
tourStepWizardInstructionsTitle - New tourStepWizardInstructionsTitle value. Default value is "Instructions"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardInstructionsTitle()
HTMLStringpublic Tour setTourStepWizardNextStepButtonTitle(java.lang.String tourStepWizardNextStepButtonTitle) throws java.lang.IllegalStateException
tourStepWizardNextStepButtonTitle - New tourStepWizardNextStepButtonTitle value. Default value is "Next Step"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardNextStepButtonTitle()
HTMLStringpublic Tour setTourStepWizardNoStepsMessage(java.lang.String tourStepWizardNoStepsMessage) throws java.lang.IllegalStateException
tourStepWizardNoStepsMessage - New tourStepWizardNoStepsMessage value. Default value is "No Tour Steps Recorded"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardNoStepsMessage()
HTMLStringpublic Tour setTourStepWizardRecordStepHeaderPrompt(java.lang.String tourStepWizardRecordStepHeaderPrompt) throws java.lang.IllegalStateException
tourStepWizardRecordStepHeaderPrompt - New tourStepWizardRecordStepHeaderPrompt value. Default value is "Drag this window out of the way to get at UI within the application"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardRecordStepHeaderPrompt()
HTMLStringpublic Tour setTourStepWizardRecordStepTitle(java.lang.String tourStepWizardRecordStepTitle) throws java.lang.IllegalStateException
tourStepWizardRecordStepTitle - New tourStepWizardRecordStepTitle value. Default value is "Record Tour Step"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardRecordStepTitle()
HTMLStringpublic Tour setTourStepWizardTargeNotifyText(java.lang.String tourStepWizardTargeNotifyText) throws java.lang.IllegalStateException
notification window when a
Target is selected for this TourStep.tourStepWizardTargeNotifyText - New tourStepWizardTargeNotifyText value. Default value is "Shift+Click on the app to record a target locator"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardTargeNotifyText()
notification window when a
Target is selected for this TourStep.HTMLStringpublic Tour setTourStepWizardTargePrompt(java.lang.String tourStepWizardTargePrompt) throws java.lang.IllegalStateException
tourStepWizardTargePrompt - New tourStepWizardTargePrompt value. Default value is "Click icon, then Shift+Click within the application to add a target"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardTargePrompt()
HTMLStringpublic Tour setTourStepWizardTargetTitle(java.lang.String tourStepWizardTargetTitle) throws java.lang.IllegalStateException
tourStepWizardTargetTitle - New tourStepWizardTargetTitle value. Default value is "Target"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardTargetTitle()
HTMLStringpublic Tour setTourStepWizardTitle(java.lang.String tourStepWizardTitle) throws java.lang.IllegalStateException
tourStepWizardTitle - New tourStepWizardTitle value. Default value is "Title"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourStepWizardTitle()
HTMLStringpublic Tour setTourWizardInteractiveTourTitle(java.lang.String tourWizardInteractiveTourTitle) throws java.lang.IllegalStateException
tourWizardInteractiveTourTitle - New tourWizardInteractiveTourTitle value. Default value is "Interactive Tutorial"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardInteractiveTourTitle()
HTMLStringpublic Tour setTourWizardNewScreenPickerTitle(java.lang.String tourWizardNewScreenPickerTitle) throws java.lang.IllegalStateException
tourWizardNewScreenPickerTitle - New tourWizardNewScreenPickerTitle value. Default value is "Start With New Screen"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardNewScreenPickerTitle()
HTMLStringpublic Tour setTourWizardRecordButtonTitle(java.lang.String tourWizardRecordButtonTitle) throws java.lang.IllegalStateException
tourWizardRecordButtonTitle - New tourWizardRecordButtonTitle value. Default value is "Record Tour"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardRecordButtonTitle()
HTMLStringpublic Tour setTourWizardReifyTourTitle(java.lang.String tourWizardReifyTourTitle) throws java.lang.IllegalStateException
tourWizardReifyTourTitle - New tourWizardReifyTourTitle value. Default value is "Reify Tutorial"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardReifyTourTitle()
HTMLStringpublic Tour setTourWizardRequiredDataSourcesHint(java.lang.String tourWizardRequiredDataSourcesHint) throws java.lang.IllegalStateException
tourWizardRequiredDataSourcesHint - New tourWizardRequiredDataSourcesHint value. Default value is "Comma separated list of required DS's"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardRequiredDataSourcesHint()
HTMLStringpublic Tour setTourWizardRequiredDataSourcesTitle(java.lang.String tourWizardRequiredDataSourcesTitle) throws java.lang.IllegalStateException
tourWizardRequiredDataSourcesTitle - New tourWizardRequiredDataSourcesTitle value. Default value is "Required DataSources"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardRequiredDataSourcesTitle()
HTMLStringpublic Tour setTourWizardShowProgressTitle(java.lang.String tourWizardShowProgressTitle) throws java.lang.IllegalStateException
tourWizardShowProgressTitle - New tourWizardShowProgressTitle value. Default value is "Show Progress"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardShowProgressTitle()
HTMLStringpublic Tour setTourWizardTitle(java.lang.String tourWizardTitle) throws java.lang.IllegalStateException
tourWizardTitle - New tourWizardTitle value. Default value is "New Tour Configuration"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardTitle()
HTMLStringpublic Tour setTourWizardTourTypeTitle(java.lang.String tourWizardTourTypeTitle) throws java.lang.IllegalStateException
tourWizardTourTypeTitle - New tourWizardTourTypeTitle value. Default value is "Tour Type"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardTourTypeTitle()
HTMLStringpublic Tour setTourWizardUITourTitle(java.lang.String tourWizardUITourTitle) throws java.lang.IllegalStateException
tourWizardUITourTitle - New tourWizardUITourTitle value. Default value is "UI Tour (Non Interactive)"Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTourWizardUITourTitle()
HTMLStringpublic Tour setWindowDefaults(Canvas windowDefaults) throws java.lang.IllegalStateException
TourStep.targetView autoChild in the
tour. These defaults are applied before TourStep.windowDefaults if any.windowDefaults - New windowDefaults value. Default value is {...}Tour instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdSGWTPropertiespublic Canvas getWindowDefaults()
TourStep.targetView autoChild in the
tour. These defaults are applied before TourStep.windowDefaults if any.public void notifyValidationMessage(java.lang.String message)
Notify system to show the message in it's default position. See notifyType for notification configuration details. message - message provided by TourStep.inputValidationNotifyMessagepublic static Tour getTour(java.lang.String tourId)
tourId - tour ID to retrieve.
See IdentifierIdentifierpublic static void loadTour(java.lang.String tourId,
ProcessCallback callback)
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.
tourId - tour ID or IDs to load.
See Identifiercallback - called when the tour is loaded with argument "process", the first tour. Other tours can be
looked up via getTour().