com.manydesigns.portofino.pageactions.form

Class FormAction

java.lang.Object

com.manydesigns.portofino.stripes.AbstractActionBean

com.manydesigns.portofino.pageactions.AbstractPageAction

com.manydesigns.portofino.pageactions.form.FormAction

All Implemented Interfaces:

DispatchElement, PageAction, ActionBean

public abstract class FormAction
extends AbstractPageAction

Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FormAction.ActionOnForm

Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

AbstractPageAction.TerminalResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	copyright
protected Form	form
static org.slf4j.Logger	logger
static String	POST_FORM_PERMISSION

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

CONF_FORM_PREFIX, DEFAULT_LAYOUT_CONTAINER, PAGE_CONFIGURATION_FIELDS, PAGE_CONFIGURATION_FIELDS_NO_DETAIL, pageConfigurationForm, pageInstance, pageTemplate, PORTOFINO_PAGEACTION_EXCEPTION, portofinoConfiguration, returnUrl, script, serverInfo, templates

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

context

Constructor Summary

Constructors

Constructor and Description
FormAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected Form	buildForm(FormBuilder formBuilder)
Resolution	configure()
protected FormBuilder	configureFormBuilder(FormBuilder formBuilder, Mode mode)
protected FormBuilder	createFormBuilder()
protected Resolution	doWithForm(FormAction.ActionOnForm closure)
protected Resolution	doWithForm(Mode mode, FormAction.ActionOnForm closure)
Resolution	execute()
protected abstract ClassAccessor	getClassAccessor() Returns the ClassAccessor to access the data underlying the form
Form	getForm()
protected Mode	getMode() Returns what mode should the form be in.
protected abstract Object	getObject() Returns the object underlying the form, e.g. from a database query.
protected Resolution	getShowFormResolution()
boolean	isFormWithRichTextFields()
Resolution	preparePage() A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation.
protected void	setupForm(Mode mode)
Resolution	updateConfiguration()
protected void	validationFailed(Form form, Object object) Invoked when form validation fails.

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

acceptsPathParameter, cancel, consumePathFragment, createTemplateSelectionProvider, forwardTo, forwardToPageActionError, forwardToPageActionNotConfigured, getActionAPIPath, getActionPath, getButtons, getConfiguration, getDefaultReturnUrl, getEmbeddedPageActions, getOgnlContext, getPage, getPageConfigurationForm, getPageDescription, getPageInstance, getPages, getPageTemplate, getParent, getPortofinoConfiguration, getResourcePath, getReturnUrl, getScript, getSubResource, initEmbeddedPageActions, isMultipartRequest, prepareConfigurationForms, prepareScript, readPageConfigurationFromRequest, saveConfiguration, setPageConfigurationForm, setPageInstance, setPageTemplate, setReturnUrl, setScript, updatePageConfiguration, updateScript, updateTemplate, validatePageConfiguration

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction

getContext

Methods inherited from interface net.sourceforge.stripes.action.ActionBean

setContext

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

logger

public static final org.slf4j.Logger logger

POST_FORM_PERMISSION

public static final String POST_FORM_PERMISSION

See Also:

Constant Field Values

form

protected Form form

Constructor Detail

FormAction

public FormAction()

Method Detail

configure

public Resolution configure()

updateConfiguration

public Resolution updateConfiguration()

preparePage

public Resolution preparePage()

Description copied from interface: PageAction

A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation. This method is invoked after the PageInstance has been injected by the framework.
Also, this method is invoked on this object after it has been invoked on the PageAction corresponding to the parent page, if any.

Returns:

either null, meaning that the dispatch process is to go forward regularly, or a Resolution to be executed, interrupting normal action invocation.

setupForm

protected void setupForm(Mode mode)

createFormBuilder

protected FormBuilder createFormBuilder()

configureFormBuilder

protected FormBuilder configureFormBuilder(FormBuilder formBuilder,
                               Mode mode)

buildForm

protected Form buildForm(FormBuilder formBuilder)

getClassAccessor

protected abstract ClassAccessor getClassAccessor()

Returns the ClassAccessor to access the data underlying the form

getObject

protected abstract Object getObject()

Returns the object underlying the form, e.g. from a database query.

getMode

protected Mode getMode()

Returns what mode should the form be in.

execute

@DefaultHandler
public Resolution execute()

doWithForm

protected Resolution doWithForm(FormAction.ActionOnForm closure)

doWithForm

protected Resolution doWithForm(Mode mode,
                    FormAction.ActionOnForm closure)

getShowFormResolution

protected Resolution getShowFormResolution()

validationFailed

protected void validationFailed(Form form,
                    Object object)

Invoked when form validation fails.

getForm

public Form getForm()

isFormWithRichTextFields

public boolean isFormWithRichTextFields()