Class TourStep
- All Implemented Interfaces:
HasHandlers
Tour. As each step is executed, it
will show a TourWindow to the user (the automatically generated targetView). At a minimum tourSteps will typically have a
title and/or description. Without a target the window will be shown in the center of the screen.
To
relate the step to a component provide a target value. An
actionType value determines what action, if any, is
expected with the target. Some actionTypes like "none" and "any" just highlight the target for
review and the user must click the next button to complete the step. Others like "click" or "change" expect the user to
interact with the target component in a certain way. Many of these will advance to the next step when the required
action is completed. See action types for details.
In most cases
the actionType can be left unset because a default is applied based on the other step properties and the
Tour.mode. However, actions like doubleClick,
rightClick and mouseOver must be provided.
To explicitly suppress automatic completion of
a step on user interaction, devlopers may set autoComplete to false.
-
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()Applied directly totargetView.Indicates the type of action that is expected with thetarget component.Target component which must clicked to processexpectedValueentered intotargetwithactionTypeof "change".ForactionType:"drag"tourSteps with adropTarget, should we allow the drop to complete and the tour to proceed if the user drops on a descendant of the drop target.booleanIf this step has a target that prompts a user for a specific action, should the step be automatically completed and have the tour move forward to the next step when the user takes this action?When set on a step with anactionTypeof "change", the entered or selected value will be automatically bound to the specified value in thetour state.Applied directly totargetView.Target component on which atargetmust be dropped to complete step.The expected value foractionType:"change".The expected value foractionType:"change".The expected value foractionType:"change".The expected value foractionType:"change".Should theexpectedValuebe matched as case-sensitive?How should theexpectedValuebe validated and notified to the user?The time between keypresses that is used duringinputValidationbefore showing the expected text notification.Message to be displayed byTour.notifyValidationMessage().Text to show in body of window.static TourStepgetOrCreateRef(JavaScriptObject jsObj) Applied directly totargetViewpointerSettings.Should thetargetViewaction buttonbe shown for this step?For a step with anactiona large arrow shows to indicate the target or direction of required action.Should thetargetViewcancel buttonbe shown for this step?ShouldinputValidationNotifyMessagebe shown as detailed inTourInputValidationMode? Defaults fromTour.showInputValidationMessageif not set.Should the target(s) be outlined? Defaults totrueinTour.mode:"tutorial".Component that is the target of this step.Automatically generated view (typically a TourWindow) to show for tour step.The name of the widget class (as a string) to use for the target view.Defaults for thetargetViewautoChild.getTitle()Title for the Window.Defaults for thetargetViewautoChild.setActionButtonTitle(String actionButtonTitle) Applied directly totargetView.setActionType(TourActionType actionType) Indicates the type of action that is expected with thetarget component.setAfterInputTarget(String afterInputTarget) Target component which must clicked to processexpectedValueentered intotargetwithactionTypeof "change".setAllowDropOnDescendants(Boolean allowDropOnDescendants) ForactionType:"drag"tourSteps with adropTarget, should we allow the drop to complete and the tour to proceed if the user drops on a descendant of the drop target.setAutoComplete(boolean autoComplete) If this step has a target that prompts a user for a specific action, should the step be automatically completed and have the tour move forward to the next step when the user takes this action?setBindEnteredText(String bindEnteredText) When set on a step with anactionTypeof "change", the entered or selected value will be automatically bound to the specified value in thetour state.setCancelButtonTitle(String cancelButtonTitle) Applied directly totargetView.setDropTarget(String dropTarget) Target component on which atargetmust be dropped to complete step.setExpectedValue(Boolean expectedValue) The expected value foractionType:"change".setExpectedValue(Integer expectedValue) The expected value foractionType:"change".setExpectedValue(String expectedValue) The expected value foractionType:"change".setExpectedValue(Date expectedValue) The expected value foractionType:"change".setExpectedValueCaseSensitive(Boolean expectedValueCaseSensitive) Should theexpectedValuebe matched as case-sensitive?setInputValidation(TourInputValidationMode inputValidation) How should theexpectedValuebe validated and notified to the user?setInputValidationNotifyDelay(Integer inputValidationNotifyDelay) The time between keypresses that is used duringinputValidationbefore showing the expected text notification.setInputValidationNotifyMessage(String inputValidationNotifyMessage) Message to be displayed byTour.notifyValidationMessage().setInstructions(String instructions) Text to show in body of window.setPointerSnapTo(String pointerSnapTo) Applied directly totargetViewpointerSettings.setShowActionButton(Boolean showActionButton) Should thetargetViewaction buttonbe shown for this step?setShowArrow(Boolean showArrow) For a step with anactiona large arrow shows to indicate the target or direction of required action.setShowCancelButton(Boolean showCancelButton) Should thetargetViewcancel buttonbe shown for this step?setShowInputValidationMessage(Boolean showInputValidationMessage) ShouldinputValidationNotifyMessagebe shown as detailed inTourInputValidationMode? Defaults fromTour.showInputValidationMessageif not set.setShowOutline(Boolean showOutline) Should the target(s) be outlined? Defaults totrueinTour.mode:"tutorial".setShowPointer(Boolean showPointer) Component that is the target of this step.setTargetViewConstructor(String targetViewConstructor) The name of the widget class (as a string) to use for the target view.setTargetViewDefaults(Canvas targetViewDefaults) Defaults for thetargetViewautoChild.Title for the Window.setWindowDefaults(Canvas windowDefaults) Defaults for thetargetViewautoChild.Methods inherited from class com.smartgwt.client.util.workflow.UserTask
cancelEditing, completeEditing, getCancelElement, getInlineView, getPassThruOutput, getPreviousElement, getSaveToServer, getTargetForm, getTargetFormAsString, getTargetVM, getWizard, goToPrevious, setCancelElement, setInlineView, setPassThruOutput, setPreviousElement, setSaveToServer, setTargetForm, setTargetForm, setTargetView, setTargetView, setTargetVM, setTargetVM, setWizardMethods inherited from class com.smartgwt.client.util.workflow.Task
getInputField, getInputFieldList, getOutputExpression, getOutputField, getOutputFieldList, setInputField, setInputFieldList, setOutputExpression, setOutputField, setOutputFieldListMethods inherited from class com.smartgwt.client.util.workflow.ProcessElement
completeElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getComponentReferences, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getInvalidTaskMessage, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setSupportsMultipleInputRecords, setTypeTitle, setUndefinedComponentMessage, setUnresolvedComponentMessage, setWaitDuration, setWaitFor, setWaitLocator, updateGlobalIDInCriteria, updateGlobalIDInTextFormula, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesMethods 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, getRef, getRuleScope, 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, setConfig, setConfigOnly, setFactoryCreated, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassName
-
Constructor Details
-
TourStep
public TourStep() -
TourStep
-
-
Method Details
-
getOrCreateRef
-
create
-
setActionButtonTitle
Applied directly totargetView. Defaults fromTour.stepActionButtonTitle.- Parameters:
actionButtonTitle- New actionButtonTitle value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getActionButtonTitle
Applied directly totargetView. Defaults fromTour.stepActionButtonTitle.- Returns:
- Current actionButtonTitle value. Default value is null
- See Also:
-
setActionType
Indicates the type of action that is expected with thetarget component.If not specified a default type is determined by the
Tour.modesetting, the target and other tourStep properties.Details:
when
tourModeis "tour"- then actionType = "none"
when
tourModeis "tutorial"- and
expectedValueorafterInputTargetare set- then actionType = "change"
- and
dropTargetis set- then actionType = "drag"
- otherwise
- actionType = "click"
- Parameters:
actionType- New actionType value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getActionType
Indicates the type of action that is expected with thetarget component.If not specified a default type is determined by the
Tour.modesetting, the target and other tourStep properties.Details:
when
tourModeis "tour"- then actionType = "none"
when
tourModeis "tutorial"- and
expectedValueorafterInputTargetare set- then actionType = "change"
- and
dropTargetis set- then actionType = "drag"
- otherwise
- actionType = "click"
- Returns:
- Current actionType value. Default value is null
-
setAfterInputTarget
Target component which must clicked to processexpectedValueentered intotargetwithactionTypeof "change".This is commonly used for a dialog where the must select a value and then click a submit button.
Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Parameters:
afterInputTarget- New afterInputTarget value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getAfterInputTarget
Target component which must clicked to processexpectedValueentered intotargetwithactionTypeof "change".This is commonly used for a dialog where the must select a value and then click a submit button.
Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Returns:
- Current afterInputTarget value. Default value is null
-
setAllowDropOnDescendants
public TourStep setAllowDropOnDescendants(Boolean allowDropOnDescendants) throws IllegalStateException ForactionType:"drag"tourSteps with adropTarget, should we allow the drop to complete and the tour to proceed if the user drops on a descendant of the drop target.For example - if a user has been prompted to drag a component into a Layout, but the layout already contains a nested child layout, should the user be able to drop into that child layout and continue the tour?
If unset this will be derived from
Tour.allowDropOnDescendants- Parameters:
allowDropOnDescendants- New allowDropOnDescendants value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getAllowDropOnDescendants
ForactionType:"drag"tourSteps with adropTarget, should we allow the drop to complete and the tour to proceed if the user drops on a descendant of the drop target.For example - if a user has been prompted to drag a component into a Layout, but the layout already contains a nested child layout, should the user be able to drop into that child layout and continue the tour?
If unset this will be derived from
Tour.allowDropOnDescendants- Returns:
- Current allowDropOnDescendants value. Default value is null
-
setAutoComplete
If this step has a target that prompts a user for a specific action, should the step be automatically completed and have the tour move forward to the next step when the user takes this action?Has no effect except on
action typesthat can auto-complete.If autoComplete is
falsethe action button is shown but is disabled until the expected action is completed at which time the button is enabled so the user can continue.- Parameters:
autoComplete- New autoComplete value. Default value is true- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getAutoComplete
public boolean getAutoComplete()If this step has a target that prompts a user for a specific action, should the step be automatically completed and have the tour move forward to the next step when the user takes this action?Has no effect except on
action typesthat can auto-complete.If autoComplete is
falsethe action button is shown but is disabled until the expected action is completed at which time the button is enabled so the user can continue.- Returns:
- Current autoComplete value. Default value is true
-
setBindEnteredText
When set on a step with anactionTypeof "change", the entered or selected value will be automatically bound to the specified value in thetour state.- Parameters:
bindEnteredText- New bindEnteredText value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getBindEnteredText
When set on a step with anactionTypeof "change", the entered or selected value will be automatically bound to the specified value in thetour state.- Returns:
- Current bindEnteredText value. Default value is null
-
setCancelButtonTitle
Applied directly totargetView. Defaults fromTour.stepCancelButtonTitle.- Parameters:
cancelButtonTitle- New cancelButtonTitle value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getCancelButtonTitle
Applied directly totargetView. Defaults fromTour.stepCancelButtonTitle.- Returns:
- Current cancelButtonTitle value. Default value is null
- See Also:
-
setDropTarget
Target component on which atargetmust be dropped to complete step. IfactionTypeis not specified and this property is provided,actionTypedefaults to "drag".Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Parameters:
dropTarget- New dropTarget value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getDropTarget
Target component on which atargetmust be dropped to complete step. IfactionTypeis not specified and this property is provided,actionTypedefaults to "drag".Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Returns:
- Current dropTarget value. Default value is null
-
setExpectedValue
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Parameters:
expectedValue- New expectedValue value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getExpectedValue
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Returns:
- Current expectedValue value. Default value is null
- See Also:
-
setExpectedValue
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Parameters:
expectedValue- New expectedValue value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getExpectedValueAsBoolean
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Returns:
- Current expectedValue value. Default value is null
- See Also:
-
setExpectedValue
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Parameters:
expectedValue- New expectedValue value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getExpectedValueAsInt
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Returns:
- Current expectedValue value. Default value is null
- See Also:
-
setExpectedValue
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Parameters:
expectedValue- New expectedValue value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getExpectedValueAsDate
The expected value foractionType:"change". The value must be matched exactly ignoring case for string values. A string value can also be matched case-sensitive by settingexpectedValueCaseSensitivetotrue.A regular expression can be used to match the entered value by providing the expected value as a string with leading and trailing slashes (ex. "/get.*/").
- Returns:
- Current expectedValue value. Default value is null
- See Also:
-
setExpectedValueCaseSensitive
public TourStep setExpectedValueCaseSensitive(Boolean expectedValueCaseSensitive) throws IllegalStateException Should theexpectedValuebe matched as case-sensitive?- Parameters:
expectedValueCaseSensitive- New expectedValueCaseSensitive value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getExpectedValueCaseSensitive
Should theexpectedValuebe matched as case-sensitive?- Returns:
- Current expectedValueCaseSensitive value. Default value is null
-
setInputValidation
public TourStep setInputValidation(TourInputValidationMode inputValidation) throws IllegalStateException How should theexpectedValuebe validated and notified to the user?Defaults to "onExit" if
afterInputTargetis specified. Otherwise the default is "notify".- Parameters:
inputValidation- New inputValidation value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getInputValidation
How should theexpectedValuebe validated and notified to the user?Defaults to "onExit" if
afterInputTargetis specified. Otherwise the default is "notify".- Returns:
- Current inputValidation value. Default value is null
-
setInputValidationNotifyDelay
public TourStep setInputValidationNotifyDelay(Integer inputValidationNotifyDelay) throws IllegalStateException The time between keypresses that is used duringinputValidationbefore showing the expected text notification. Does not apply toinputValidation="onExit".- Parameters:
inputValidationNotifyDelay- New inputValidationNotifyDelay value. Default value is 500- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getInputValidationNotifyDelay
The time between keypresses that is used duringinputValidationbefore showing the expected text notification. Does not apply toinputValidation="onExit".- Returns:
- Current inputValidationNotifyDelay value. Default value is 500
-
setInputValidationNotifyMessage
public TourStep setInputValidationNotifyMessage(String inputValidationNotifyMessage) throws IllegalStateException Message to be displayed byTour.notifyValidationMessage().This is a dynamic string - text within
${...}are dynamic variables and will be evaluated as JS code when the message is displayed.Only two dynamic variables, value and expectedValue, are available and represent the currently entered and expected values.
- Parameters:
inputValidationNotifyMessage- New inputValidationNotifyMessage value. Default value is "Please enter '${expectedValue}'"- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getInputValidationNotifyMessage
Message to be displayed byTour.notifyValidationMessage().This is a dynamic string - text within
${...}are dynamic variables and will be evaluated as JS code when the message is displayed.Only two dynamic variables, value and expectedValue, are available and represent the currently entered and expected values.
- Returns:
- Current inputValidationNotifyMessage value. Default value is "Please enter '${expectedValue}'"
-
setInstructions
Text to show in body of window.- Parameters:
instructions- New instructions value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getInstructions
Text to show in body of window.- Returns:
- Current instructions value. Default value is null
- See Also:
-
setPointerSnapTo
Applied directly totargetViewpointerSettings.- Parameters:
pointerSnapTo- New pointerSnapTo value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getPointerSnapTo
Applied directly totargetViewpointerSettings.- Returns:
- Current pointerSnapTo value. Default value is null
- See Also:
-
setShowActionButton
Should thetargetViewaction buttonbe shown for this step?If no value is provided it will be defaulted to
truewhenautoCompleteisnot falseand any of the following are true:actionTypeis "click"- actionType is "mouseDown"
- actionType is "doubleClick"
- actionType is "rightClick"
- actionType is "menuItemOpen"
- actionType is "menuItemSelect"
- actionType is "change" and an
expectedValueis provided - a
dropTargetis provided
If no value is provided and autoComplete is
falsebut auto completion would normally occur (i.e. actionType "click", "change" with expectedValue, etc.) then the action button is shown but is disabled until the expected action is completed at which time the button is enabled so the user can continue.- Parameters:
showActionButton- New showActionButton value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowActionButton
Should thetargetViewaction buttonbe shown for this step?If no value is provided it will be defaulted to
truewhenautoCompleteisnot falseand any of the following are true:actionTypeis "click"- actionType is "mouseDown"
- actionType is "doubleClick"
- actionType is "rightClick"
- actionType is "menuItemOpen"
- actionType is "menuItemSelect"
- actionType is "change" and an
expectedValueis provided - a
dropTargetis provided
If no value is provided and autoComplete is
falsebut auto completion would normally occur (i.e. actionType "click", "change" with expectedValue, etc.) then the action button is shown but is disabled until the expected action is completed at which time the button is enabled so the user can continue.- Returns:
- Current showActionButton value. Default value is null
-
setShowArrow
For a step with anactiona large arrow shows to indicate the target or direction of required action. SettingshowArrowtofalsesuppresses the display of the arrow. Note that the tour window is shown as if the arrow were there.ShowPointertakes precedence overshowArrow:true.- Parameters:
showArrow- New showArrow value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getShowArrow
For a step with anactiona large arrow shows to indicate the target or direction of required action. SettingshowArrowtofalsesuppresses the display of the arrow. Note that the tour window is shown as if the arrow were there.ShowPointertakes precedence overshowArrow:true.- Returns:
- Current showArrow value. Default value is null
- See Also:
-
setShowCancelButton
Should thetargetViewcancel buttonbe shown for this step?If no value is provided it will be defaulted to
trueunless this step is the last step in the tour.- Parameters:
showCancelButton- New showCancelButton value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowCancelButton
Should thetargetViewcancel buttonbe shown for this step?If no value is provided it will be defaulted to
trueunless this step is the last step in the tour.- Returns:
- Current showCancelButton value. Default value is null
-
setShowInputValidationMessage
public TourStep setShowInputValidationMessage(Boolean showInputValidationMessage) throws IllegalStateException ShouldinputValidationNotifyMessagebe shown as detailed inTourInputValidationMode? Defaults fromTour.showInputValidationMessageif not set.If set to
falsereporting messages to the user are suppressed and thereforeTour.notifyValidationMessage()will not be called.- Parameters:
showInputValidationMessage- New showInputValidationMessage value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getShowInputValidationMessage
ShouldinputValidationNotifyMessagebe shown as detailed inTourInputValidationMode? Defaults fromTour.showInputValidationMessageif not set.If set to
falsereporting messages to the user are suppressed and thereforeTour.notifyValidationMessage()will not be called.- Returns:
- Current showInputValidationMessage value. Default value is null
-
setShowOutline
Should the target(s) be outlined? Defaults totrueinTour.mode:"tutorial".- Parameters:
showOutline- New showOutline value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getShowOutline
Should the target(s) be outlined? Defaults totrueinTour.mode:"tutorial".- Returns:
- Current showOutline value. Default value is null
- See Also:
-
setShowPointer
- Parameters:
showPointer- New showPointer value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getShowPointer
- Returns:
- Current showPointer value. Default value is null
- See Also:
-
setTarget
Component that is the target of this step. The interaction for this step is indicated inactionType. For actions that need multiple targets, this target is the primary one.Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Parameters:
target- New target value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTarget
Component that is the target of this step. The interaction for this step is indicated inactionType. For actions that need multiple targets, this target is the primary one.Target may be specified as a
GlobalIdfor a Component or FormItem, or as aAutoTestLocatorfor an element.- Returns:
- Current target value. Default value is null
-
getTargetView
Automatically generated view (typically a TourWindow) to show for tour step.The following
passthroughsapply:pointerSnapTofor theCanvas.pointerSettingsshowCancelButtonfor theTourWindow.showCancelButtoncancelButtonTitlefor theTourWindow.cancelButtonTitleactionButtonTitlefor theTourWindow.actionButtonTitle
This component is an AutoChild named "targetView". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Overrides:
getTargetViewin classUserTask- Returns:
- Current targetView value. Default value is null
- Throws:
IllegalStateException- if the underlying component has not yet been created.
-
setTargetViewConstructor
The name of the widget class (as a string) to use for the target view.- Parameters:
targetViewConstructor- New targetViewConstructor value. Default value is "TourWindow"- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTargetViewConstructor
The name of the widget class (as a string) to use for the target view.- Returns:
- Current targetViewConstructor value. Default value is "TourWindow"
-
setTargetViewDefaults
Defaults for thetargetViewautoChild.- Parameters:
targetViewDefaults- New targetViewDefaults value. Default value is {...}- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTargetViewDefaults
Defaults for thetargetViewautoChild.- Returns:
- Current targetViewDefaults value. Default value is {...}
-
setTitle
Title for the Window.- Parameters:
title- New title value. Default value is null- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTitle
Title for the Window.- Returns:
- Current title value. Default value is null
- See Also:
-
setWindowDefaults
Defaults for thetargetViewautoChild. These defaults are applied afterTour.windowDefaultsif any.- Parameters:
windowDefaults- New windowDefaults value. Default value is {...}- Returns:
TourStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getWindowDefaults
Defaults for thetargetViewautoChild. These defaults are applied afterTour.windowDefaultsif any.- Returns:
- Current windowDefaults value. Default value is {...}
-