Package org.nuxeo.ecm.webengine.ui.wizard

Class Wizard

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.webengine.ui.wizard.Wizard

All Implemented Interfaces:

Resource, Adaptable

Direct Known Subclasses:

WebForm

public abstract class Wizard
extends DefaultObject

The following actions are available:

• GET
• POST next
• POST ok
• POST cancel
• POST back

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	EMPTY
protected ValidationException	error
protected Map<String,String[]>	initialFields
protected WizardPage	page
protected WizardSession	session

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
Wizard()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String[]>	createInitialFields()
protected abstract WizardPage[]	createPages()
protected String	createSessionId()
protected void	destroySession()
Object	doGet()	Get the content of the current wizard page.
ValidationException	getError()
String	getField(String key)
String[]	getFields(String key)
<T extends Form> T	getForm(Class<T> formType)
Map<String,String[]>	getFormFields()
Collection<String>	getInvalidFields()
WizardPage	getPage()
Collection<String>	getRequireddFields()
WizardSession	getSession()
Object	handleBack()
Object	handleCancel()
protected Object	handleError(Throwable e)
Object	handleNext()
Object	handleOk()
protected Object	handleValidationError(ValidationException e)
boolean	hasErrors()
boolean	hasErrors(String key)
protected void	initialize(Object... args)
boolean	isBackEnabled()
boolean	isCancelEnabled()
boolean	isNextEnabled()
boolean	isOkEnabled()
protected void	performCancel()
protected abstract void	performOk()
protected Object	redirectOnCancel()
protected Object	redirectOnOk()
<T extends Form> T	validate(WizardPage page)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, retrieveWebObjectType, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final String[] EMPTY

session

protected WizardSession session

page

protected WizardPage page

error

protected ValidationException error

initialFields

protected Map<String,String[]> initialFields

Constructor Details

Wizard

public Wizard()

Method Details

createPages

protected abstract WizardPage[] createPages()

createInitialFields

protected Map<String,String[]> createInitialFields()

initialize

protected void initialize(Object... args)

Overrides:

initialize in class AbstractResource<ResourceTypeImpl>

destroySession

protected void destroySession()

createSessionId

protected String createSessionId()

getSession

public WizardSession getSession()

getPage

public WizardPage getPage()

isNextEnabled

public boolean isNextEnabled()

isBackEnabled

public boolean isBackEnabled()

isOkEnabled

public boolean isOkEnabled()

isCancelEnabled

public boolean isCancelEnabled()

getError

public ValidationException getError()

getFormFields

public Map<String,String[]> getFormFields()

getField

public String getField(String key)

getFields

public String[] getFields(String key)

getInvalidFields

public Collection<String> getInvalidFields()

getRequireddFields

public Collection<String> getRequireddFields()

hasErrors

public boolean hasErrors()

hasErrors

public boolean hasErrors(String key)

redirectOnOk

protected Object redirectOnOk()

redirectOnCancel

protected Object redirectOnCancel()

getForm

public <T extends Form> T getForm(Class<T> formType)

performOk

protected abstract void performOk()
                           throws ValidationException

Throws:

ValidationException

performCancel

protected void performCancel()

handleValidationError

protected Object handleValidationError(ValidationException e)

handleError

protected Object handleError(Throwable e)

validate

public <T extends Form> T validate(WizardPage page)
                            throws ValidationException

Throws:

ValidationException

handleNext

public Object handleNext()

handleBack

public Object handleBack()

handleCancel

public Object handleCancel()

handleOk

public Object handleOk()

doGet

public Object doGet()

Get the content of the current wizard page.