public class TourConfirmStep extends UserTask
If the user clicks OK,
the nextElement is chosen, otherwise the choice is
failureElement.
config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
TourConfirmStep() |
TourConfirmStep(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getActionButtonTitle()
Applied directly to
targetView. |
java.lang.String |
getCancelButtonTitle()
Applied directly to
targetView. |
java.lang.String |
getFailureElement()
ID of the next element to process if the user clicks the
cancelButton. |
java.lang.String |
getInstructions()
Text to show in body of window.
|
java.lang.String |
getNextElement()
Next
element to execute if the user clicks the
actionButton. |
static TourConfirmStep |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getShowActionButton()
Should the
targetView action button be shown for this step? |
java.lang.Boolean |
getShowCancelButton()
Should the
targetView cancel button be shown for this step? |
Canvas |
getTargetView()
Automatically generated view (typically a window) to show for tour step.
|
java.lang.String |
getTargetViewConstructor()
The name of the widget class (as a string) to use for the target view.
|
Canvas |
getTargetViewDefaults()
Defaults for the
targetView autoChild. |
java.lang.String |
getTitle()
Title for the Window.
|
TourConfirmStep |
setActionButtonTitle(java.lang.String actionButtonTitle)
Applied directly to
targetView. |
TourConfirmStep |
setCancelButtonTitle(java.lang.String cancelButtonTitle)
Applied directly to
targetView. |
TourConfirmStep |
setFailureElement(java.lang.String failureElement)
ID of the next element to process if the user clicks the
cancelButton. |
TourConfirmStep |
setInstructions(java.lang.String instructions)
Text to show in body of window.
|
TourConfirmStep |
setNextElement(java.lang.String nextElement)
Next
element to execute if the user clicks the
actionButton. |
TourConfirmStep |
setShowActionButton(java.lang.Boolean showActionButton)
Should the
targetView action button be shown for this step? |
TourConfirmStep |
setShowCancelButton(java.lang.Boolean showCancelButton)
Should the
targetView cancel button be shown for this step? |
TourConfirmStep |
setTargetViewConstructor(java.lang.String targetViewConstructor)
The name of the widget class (as a string) to use for the target view.
|
TourConfirmStep |
setTargetViewDefaults(Canvas targetViewDefaults)
Defaults for the
targetView autoChild. |
TourConfirmStep |
setTitle(java.lang.String title)
Title for the Window.
|
cancelEditing, completeEditing, getCancelElement, getInlineView, getPassThruOutput, getPreviousElement, getSaveToServer, getTargetForm, getTargetFormAsString, getTargetVM, getWizard, goToPrevious, setCancelElement, setInlineView, setPassThruOutput, setPreviousElement, setSaveToServer, setTargetForm, setTargetForm, setTargetView, setTargetView, setTargetVM, setTargetVM, setWizardgetInputField, getInputFieldList, getOutputExpression, getOutputField, getOutputFieldList, setInputField, setInputFieldList, setOutputExpression, setOutputField, setOutputFieldListcompleteElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getJsObj, getMockMode, getOrCreateJsObj, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, isCreated, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setSupportsMultipleInputRecords, setTypeTitle, updateGlobalIDInCriteria, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesaddDynamicProperty, 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, setScClassNamepublic TourConfirmStep()
public TourConfirmStep(com.google.gwt.core.client.JavaScriptObject jsObj)
public static TourConfirmStep getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
public TourConfirmStep setActionButtonTitle(java.lang.String actionButtonTitle) throws java.lang.IllegalStateException
targetView.actionButtonTitle - New actionButtonTitle value. Default value is "OK"TourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getActionButtonTitle()
targetView.HTMLStringpublic TourConfirmStep setCancelButtonTitle(java.lang.String cancelButtonTitle) throws java.lang.IllegalStateException
targetView.cancelButtonTitle - New cancelButtonTitle value. Default value is "CancelTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getCancelButtonTitle()
targetView.HTMLStringpublic TourConfirmStep setFailureElement(java.lang.String failureElement) throws java.lang.IllegalStateException
cancelButton. If not set, the process will exit.failureElement - New failureElement value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getFailureElement()
cancelButton. If not set, the process will exit.public TourConfirmStep setInstructions(java.lang.String instructions) throws java.lang.IllegalStateException
instructions - New instructions value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLString,
Appearance overview and related methodspublic java.lang.String getInstructions()
HTMLString,
Appearance overview and related methodspublic TourConfirmStep setNextElement(java.lang.String nextElement) throws java.lang.IllegalStateException
element to execute if the user clicks the
actionButton. nextElement does not need to be specified if this gateway is part of a
sequence and has a next element in the sequence. This is
normal for a tour.
setNextElement in class ProcessElementnextElement - New nextElement value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getNextElement()
element to execute if the user clicks the
actionButton. nextElement does not need to be specified if this gateway is part of a
sequence and has a next element in the sequence. This is
normal for a tour.
getNextElement in class ProcessElementpublic TourConfirmStep setShowActionButton(java.lang.Boolean showActionButton) throws java.lang.IllegalStateException
targetView action button be shown for this step? If no value
is provided it will be defaulted to true.
showActionButton - New showActionButton value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowActionButton()
targetView action button be shown for this step? If no value
is provided it will be defaulted to true.
public TourConfirmStep setShowCancelButton(java.lang.Boolean showCancelButton) throws java.lang.IllegalStateException
targetView cancel button be shown for this step? If no value
is provided it will be defaulted to true.
showCancelButton - New showCancelButton value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowCancelButton()
targetView cancel button be shown for this step? If no value
is provided it will be defaulted to true.
public Canvas getTargetView() throws java.lang.IllegalStateException
The following passthroughs apply:
showCancelButton for the TourWindow.showCancelButtoncancelButtonTitle for the TourWindow.cancelButtonTitleactionButtonTitle for the TourWindow.actionButtonTitle
This component is an AutoChild named "targetView". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
getTargetView in class UserTaskjava.lang.IllegalStateException - if the underlying component has not yet been created.public TourConfirmStep setTargetViewConstructor(java.lang.String targetViewConstructor) throws java.lang.IllegalStateException
targetViewConstructor - New targetViewConstructor value. Default value is "TourWindow"TourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getTargetViewConstructor()
public TourConfirmStep setTargetViewDefaults(Canvas targetViewDefaults) throws java.lang.IllegalStateException
targetView autoChild.targetViewDefaults - New targetViewDefaults value. Default value is {...}TourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdSGWTPropertiespublic Canvas getTargetViewDefaults()
targetView autoChild.public TourConfirmStep setTitle(java.lang.String title) throws java.lang.IllegalStateException
title - New title value. Default value is nullTourConfirmStep instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLString,
Appearance overview and related methodspublic java.lang.String getTitle()
HTMLString,
Appearance overview and related methods