Class TourConfirmStep
- All Implemented Interfaces:
HasHandlers
If the user clicks OK,
the nextElement is chosen, otherwise the choice is
failureElement.
-
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.Applied directly totargetView.ID of the next element to process if the user clicks thecancelButton.Text to show in body of window.Nextelementto execute if the user clicks theactionButton.static TourConfirmStepgetOrCreateRef(JavaScriptObject jsObj) Should thetargetViewaction buttonbe shown for this step?Should thetargetViewcancel buttonbe shown for this step?Automatically generated view (typically a window) 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.setActionButtonTitle(String actionButtonTitle) Applied directly totargetView.setCancelButtonTitle(String cancelButtonTitle) Applied directly totargetView.setFailureElement(String failureElement) ID of the next element to process if the user clicks thecancelButton.setInstructions(String instructions) Text to show in body of window.setNextElement(String nextElement) Nextelementto execute if the user clicks theactionButton.setShowActionButton(Boolean showActionButton) Should thetargetViewaction buttonbe shown for this step?setShowCancelButton(Boolean showCancelButton) Should thetargetViewcancel buttonbe shown for 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.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, getOrCreateJsObj, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, 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
-
TourConfirmStep
public TourConfirmStep() -
TourConfirmStep
-
-
Method Details
-
getOrCreateRef
-
create
-
setActionButtonTitle
Applied directly totargetView.- Parameters:
actionButtonTitle- New actionButtonTitle value. Default value is "OK"- Returns:
TourConfirmStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getActionButtonTitle
Applied directly totargetView.- Returns:
- Current actionButtonTitle value. Default value is "OK"
- See Also:
-
setCancelButtonTitle
Applied directly totargetView.- Parameters:
cancelButtonTitle- New cancelButtonTitle value. Default value is "Cancel- Returns:
TourConfirmStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getCancelButtonTitle
Applied directly totargetView.- Returns:
- Current cancelButtonTitle value. Default value is "Cancel
- See Also:
-
setFailureElement
ID of the next element to process if the user clicks thecancelButton. If not set, the process will exit.- Parameters:
failureElement- New failureElement value. Default value is null- Returns:
TourConfirmStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getFailureElement
ID of the next element to process if the user clicks thecancelButton. If not set, the process will exit.- Returns:
- Current failureElement value. Default value is null
-
setInstructions
Text to show in body of window.- Parameters:
instructions- New instructions value. Default value is null- Returns:
TourConfirmStepinstance, 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:
-
setNextElement
Nextelementto execute if the user clicks theactionButton.nextElementdoes not need to be specified if this gateway is part of asequenceand has a next element in the sequence. This is normal for a tour.- Overrides:
setNextElementin classProcessElement- Parameters:
nextElement- New nextElement value. Default value is null- Returns:
TourConfirmStepinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getNextElement
Nextelementto execute if the user clicks theactionButton.nextElementdoes not need to be specified if this gateway is part of asequenceand has a next element in the sequence. This is normal for a tour.- Overrides:
getNextElementin classProcessElement- Returns:
- Current nextElement value. Default value is null
-
setShowActionButton
Should thetargetViewaction buttonbe shown for this step?If no value is provided it will be defaulted to
true.- Parameters:
showActionButton- New showActionButton value. Default value is null- Returns:
TourConfirmStepinstance, 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
true.- Returns:
- Current showActionButton value. Default value is null
-
setShowCancelButton
Should thetargetViewcancel buttonbe shown for this step?If no value is provided it will be defaulted to
true.- Parameters:
showCancelButton- New showCancelButton value. Default value is null- Returns:
TourConfirmStepinstance, 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
true.- Returns:
- Current showCancelButton value. Default value is null
-
getTargetView
Automatically generated view (typically a window) to show for tour step.The following
passthroughsapply:showCancelButtonfor 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
public TourConfirmStep setTargetViewConstructor(String targetViewConstructor) throws IllegalStateException 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:
TourConfirmStepinstance, 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
public TourConfirmStep setTargetViewDefaults(Canvas targetViewDefaults) throws IllegalStateException Defaults for thetargetViewautoChild.- Parameters:
targetViewDefaults- New targetViewDefaults value. Default value is {...}- Returns:
TourConfirmStepinstance, 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:
TourConfirmStepinstance, 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:
-