Interface WizardPageController
- All Known Implementing Classes:
AssignColumnWizardController,AssignQueryPermissionsWizardController,AssignSavedQueryPermissionsWizardController,AssignWorkflowWizardController,CmsComponentController,CmsContentEditorRelatedTypeWizardController,CmsDecisionPageController,CmsPageController,CmsReferencePageController,CmsReferenceSelectorPageController,CmsSiteMandatoryPageController,CmsTypePageController,ComponentsAdvancedSearchPageController,ContentCatalogCreatePageController,CreateCmsPageController,DefaultAdvancedSearchPageController,DefaultAdvancedSearchPageController,DefaultDecisionPageController,DefaultGenericItemMandatoryPageController,DefaultGenericTypeSelectorPageController,DefaultNavigationItemsWizardController,DefaultNavigationNodeWizardController,DefaultPageController,NavigationNodeMandatoryPageController,RelatedTypeAdvancedSearchPageController,ResetConfigWizardController,UploadMediaFirstPageController,UploadMediaPageController,UploadMediaSecondPageController
public interface WizardPageController
This class was moved to ext/cockpit from productcockpit
-
Method Summary
Modifier and TypeMethodDescriptionvoidbeforeBack(Wizard wizard, WizardPage page) This method is invoked before proceeding to the previous page.voidbeforeNext(Wizard wizard, WizardPage page) This method is invoked before proceeding to the next page.voidcancel(Wizard wizard, WizardPage page) This method is invoked when the cancel button is pressed.voiddone(Wizard wizard, WizardPage page) This method is invoked when the done button is pressed.getFirstPage(Wizard wizard) Returns the first page of the wizard.voidinitPage(Wizard wizard, WizardPage page) This method is invoked whenever a wizard page is created.next(Wizard wizard, WizardPage page) Returns for the specified wizard page the next page.previous(Wizard wizard, WizardPage page) Returns for the specified wizard page the previous page.booleanvalidate(Wizard wizard, WizardPage page) This method is invoked before leaving a page.
-
Method Details
-
getFirstPage
Returns the first page of the wizard. -
validate
This method is invoked before leaving a page. Implement it to validate the input data.- Returns:
- true, if the page content is correct, false otherwise. If false is returned, the wizard will not proceed to the next page.
-
initPage
This method is invoked whenever a wizard page is created. Implement it to do some preparations for your page.- Parameters:
wizard- the wizard which contains the pagepage- the currently accessed page
-
next
Returns for the specified wizard page the next page. Should be implemented for complex wizard flow calculation.- Parameters:
wizard- the wizard which contains the pagespage- the current page- Returns:
- the next page
-
previous
Returns for the specified wizard page the previous page. Should be implemented for complex wizard flow calculation.- Parameters:
wizard- the wizard which contains the pagespage- the current page- Returns:
- the previous page
-
cancel
This method is invoked when the cancel button is pressed. Can be used to cleanup stuff done by the wizard.- Parameters:
wizard- the wizard which contains the pagepage- the currently accessed page
-
done
This method is invoked when the done button is pressed.- Parameters:
wizard- the wizard which contains the pagepage- the currently accessed page- Throws:
WizardConfirmationException
-
beforeNext
This method is invoked before proceeding to the next page.- Parameters:
wizard- the wizard which contains the pagepage- the currently accessed page
-
beforeBack
This method is invoked before proceeding to the previous page.- Parameters:
wizard- the wizard which contains the pagepage- the currently accessed page
-