Package de.hybris.platform.cockpit.wizards.impl

Class DefaultPageController

java.lang.Object

de.hybris.platform.cockpit.wizards.impl.DefaultPageController

All Implemented Interfaces:

WizardPageController

Direct Known Subclasses:

AssignColumnWizardController, AssignQueryPermissionsWizardController, AssignSavedQueryPermissionsWizardController, AssignWorkflowWizardController, DefaultAdvancedSearchPageController, DefaultDecisionPageController, DefaultGenericItemMandatoryPageController, DefaultGenericTypeSelectorPageController, ResetConfigWizardController

public class DefaultPageController
extends java.lang.Object
implements WizardPageController

This class was moved to ext/cockpit from productcockpit

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.util.List<Transition>>	transitions

Constructor Summary

Constructors

Constructor	Description
DefaultPageController()

Method Summary

Modifier and Type	Method	Description
void	beforeBack(Wizard wizard, WizardPage page)	This method is invoked before proceeding to the previous page.
void	beforeNext(Wizard wizard, WizardPage page)	This method is invoked before proceeding to the next page.
void	cancel(Wizard wizard, WizardPage page)	This method is invoked when the cancel button is pressed.
void	done(Wizard wizard, WizardPage page)	This method is invoked when the done button is pressed.
protected boolean	evaluateAttribute(java.lang.String attribute, Wizard wizard)
protected boolean	evaluateTransition(Transition transition, Wizard wizard)
WizardPage	getFirstPage(Wizard wizard)	Returns the first page of the wizard.
void	initPage(Wizard wizard, WizardPage page)	This method is invoked whenever a wizard page is created.
WizardPage	next(Wizard wizard, WizardPage page)	Returns for the specified wizard page the next page.
WizardPage	previous(Wizard wizard, WizardPage page)	Returns for the specified wizard page the previous page.
void	setTransitions(java.util.List<Transition> transitions)
boolean	validate(Wizard wizard, WizardPage page)	This method is invoked before leaving a page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

transitions

protected java.util.Map<java.lang.String,java.util.List<Transition>> transitions

Constructor Detail

DefaultPageController

public DefaultPageController()

Method Detail

setTransitions

public void setTransitions(java.util.List<Transition> transitions)

cancel

public void cancel(Wizard wizard,
                   WizardPage page)

Description copied from interface: WizardPageController

This method is invoked when the cancel button is pressed. Can be used to cleanup stuff done by the wizard.

Specified by:

cancel in interface WizardPageController

Parameters:

wizard - the wizard which contains the page

page - the currently accessed page

done

public void done(Wizard wizard,
                 WizardPage page)
          throws WizardConfirmationException

Description copied from interface: WizardPageController

This method is invoked when the done button is pressed.

Specified by:

done in interface WizardPageController

Parameters:

wizard - the wizard which contains the page

page - the currently accessed page

Throws:

WizardConfirmationException

getFirstPage

public WizardPage getFirstPage(Wizard wizard)

Description copied from interface: WizardPageController

Returns the first page of the wizard.

Specified by:

getFirstPage in interface WizardPageController

initPage

public void initPage(Wizard wizard,
                     WizardPage page)

Description copied from interface: WizardPageController

This method is invoked whenever a wizard page is created. Implement it to do some preparations for your page.

Specified by:

initPage in interface WizardPageController

Parameters:

wizard - the wizard which contains the page

page - the currently accessed page

evaluateAttribute

protected boolean evaluateAttribute(java.lang.String attribute,
                                    Wizard wizard)

evaluateTransition

protected boolean evaluateTransition(Transition transition,
                                     Wizard wizard)

next

public WizardPage next(Wizard wizard,
                       WizardPage page)

Description copied from interface: WizardPageController

Returns for the specified wizard page the next page. Should be implemented for complex wizard flow calculation.

Specified by:

next in interface WizardPageController

Parameters:

wizard - the wizard which contains the pages

page - the current page

Returns:

the next page

previous

public WizardPage previous(Wizard wizard,
                           WizardPage page)

Description copied from interface: WizardPageController

Returns for the specified wizard page the previous page. Should be implemented for complex wizard flow calculation.

Specified by:

previous in interface WizardPageController

Parameters:

wizard - the wizard which contains the pages

page - the current page

Returns:

the previous page

validate

public boolean validate(Wizard wizard,
                        WizardPage page)

Description copied from interface: WizardPageController

This method is invoked before leaving a page. Implement it to validate the input data.

Specified by:

validate in interface WizardPageController

Returns:

true, if the page content is correct, false otherwise. If false is returned, the wizard will not proceed to the next page.

beforeBack

public void beforeBack(Wizard wizard,
                       WizardPage page)

Description copied from interface: WizardPageController

This method is invoked before proceeding to the previous page.

Specified by:

beforeBack in interface WizardPageController

Parameters:

wizard - the wizard which contains the page

page - the currently accessed page

beforeNext

public void beforeNext(Wizard wizard,
                       WizardPage page)

Description copied from interface: WizardPageController

This method is invoked before proceeding to the next page.

Specified by:

beforeNext in interface WizardPageController

Parameters:

wizard - the wizard which contains the page

page - the currently accessed page