public class SampleWizard extends GeneratedSampleWizard
LocalizableItem.LocalizableItemImplExtensibleItem.ExtensibleItemImplItem.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationExceptionLOCALIZEDFIELD, SECONDS, STRINGLIST, UNITLISTBACK_BUTTON, BACK_BUTTON_NAME, CANCEL_BUTTON, CANCEL_BUTTON_NAME, CLOSE_BUTTON_NAME, DONE_BUTTON_NAME, NEXT_BUTTON, NEXT_BUTTON_NAME, START_BUTTON, START_BUTTON_NAMELANGUAGE_FALLBACK_ENABLED_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPEimpl, tenant| Constructor and Description |
|---|
SampleWizard() |
| Modifier and Type | Method and Description |
|---|---|
void |
close(WizardEditorContext ctx)
Called if the wizard window is going to be closed.
|
void |
initialize(WizardEditorContext ctx)
Called to initialize the wizard immediately after the item editor creates the WizardEditorContext.
|
void |
pollStatus(WizardEditorContext ctx)
Called during processing mode every time the wizards refreshes its status information.
|
void |
start(WizardEditorContext ctx)
Called if the user requests the wizard to start its actions.
|
void |
tabChanges(WizardEditorContext ctx,
String fromTabName,
String toTabName)
Called before the current tab is changed.
|
void |
validate(WizardEditorContext ctx,
String fromTab,
String toTab)
Called before
tab is changed
start event delivered
or if validation was explicitely requested.
|
getAllLocalizedField, getAllLocalizedField, getLocalizedField, getLocalizedField, getSeconds, getSeconds, getSecondsAsPrimitive, getSecondsAsPrimitive, getStringList, getStringList, getUnitList, getUnitList, setAllLocalizedField, setAllLocalizedField, setLocalizedField, setLocalizedField, setSeconds, setSeconds, setSeconds, setSeconds, setStringList, setStringList, setUnitList, setUnitListabortProcessing, appendLocalizedTemplateString, createItem, doGetAttribute, doSetAttribute, endProcessing, getLocalizedTemplateString, isCloseAllowed, provideComposedType, provideCreationTime, provideModificationTime, providePK, removeJaloOnly, setClosedAllowed, startProcessing, validategetAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedPropertycreateNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setPropertyaddLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getNonInitialAttributes, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplacegetImplementation, setTenantpublic void tabChanges(WizardEditorContext ctx, String fromTabName, String toTabName) throws VetoException
WizardBusinessItemVetoException must be raised. In this case a error popup is shown.tabChanges in class WizardBusinessItemctx - the wizard editor contextfromTabName - the current tab nametoTabName - the new tab nameVetoException - to signal the tab cannot be changed right nowpublic void pollStatus(WizardEditorContext ctx)
WizardBusinessItemWizardEditorContext.setStatus(String, int, boolean) to update the displayed status.
The method is called before the wizard is rendered. So changing the procesing mode here is allowed.
pollStatus in class WizardBusinessItemctx - the wizard editor contextpublic void validate(WizardEditorContext ctx, String fromTab, String toTab) throws ValidationException
WizardBusinessItem
To check current input values use ItemEditorContext.getCurrentValue(String).
To signal an error a ValidationException must be raised. The actual event (tab change or start of this
wizard) is not executed in this case but a error popup is shown.
Additionally erroneous fields may be marked via ItemEditorContext.showError(String, String).
Make sure that always super.validate is called !
validate in class WizardBusinessItemctx - the wizard editor contextfromTab - the tab which is being lefttoTab - the new target tabValidationExceptionpublic void close(WizardEditorContext ctx) throws VetoException
WizardBusinessItemclose in class WizardBusinessItemctx - the wizard editor contextVetoException - to signal that the window cannot be closed right now.public void start(WizardEditorContext ctx) throws VetoException
WizardBusinessItemstart in class WizardBusinessItemctx - the wizard editor contextVetoException - to signal that the wizard cannot be started right nowpublic void initialize(WizardEditorContext ctx)
WizardBusinessIteminitialize in class WizardBusinessItemctx - the wizard editor contextCopyright © 2017 SAP SE. All Rights Reserved.