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

static java.lang.String[]

EMPTY

Constructor Summary

Wizard()

Method Summary

java.lang.Object	doGet() Get the content of the current wizard page.
ValidationException	getError()
java.lang.String	getField(java.lang.String key)
java.lang.String[]	getFields(java.lang.String key)
<T extends Form> T	getForm(java.lang.Class<T> formType)
java.util.Map<java.lang.String,java.lang.String[]>	getFormFields()
java.util.Collection<java.lang.String>	getInvalidFields()
WizardPage	getPage()
java.util.Collection<java.lang.String>	getRequireddFields()
WizardSession	getSession()
java.lang.Object	handleBack()
java.lang.Object	handleCancel()
java.lang.Object	handleNext()
java.lang.Object	handleOk()
boolean	hasErrors()
boolean	hasErrors(java.lang.String key)
boolean	isBackEnabled()
boolean	isCancelEnabled()
boolean	isNextEnabled()
boolean	isOkEnabled()
<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, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final java.lang.String[] EMPTY

Constructor Detail

Wizard

public Wizard()

Method Detail

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 java.util.Map<java.lang.String,java.lang.String[]> getFormFields()

getField

public java.lang.String getField(java.lang.String key)

getFields

public java.lang.String[] getFields(java.lang.String key)

getInvalidFields

public java.util.Collection<java.lang.String> getInvalidFields()

getRequireddFields

public java.util.Collection<java.lang.String> getRequireddFields()

hasErrors

public boolean hasErrors()

hasErrors

public boolean hasErrors(java.lang.String key)

getForm

public <T extends Form> T getForm(java.lang.Class<T> formType)

validate

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

Throws:

ValidationException

handleNext

public java.lang.Object handleNext()

handleBack

public java.lang.Object handleBack()

handleCancel

public java.lang.Object handleCancel()

handleOk

public java.lang.Object handleOk()

doGet

public java.lang.Object doGet()

Get the content of the current wizard page.