|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.riotfamily.forms.controller.AbstractFormController
public abstract class AbstractFormController
Abstract base class for controllers that display a form.
Field Summary | |
---|---|
protected static String |
BUTTON_CONTAINER_ID
|
static String |
FORM_SUBMISSION_HANDLER
|
protected RiotLog |
log
|
Constructor Summary | |
---|---|
AbstractFormController()
|
Method Summary | |
---|---|
protected Form |
createAndInitForm(HttpServletRequest request,
HttpServletResponse response)
Creates and initializes a form. |
protected abstract Form |
createForm(HttpServletRequest request)
Subclasses must implement this method and return a fresh Form instance. |
protected ModelAndView |
createModelAndView(Form form,
HttpServletRequest request,
HttpServletResponse response)
|
protected Form |
getForm(HttpServletRequest request)
Returns the Form for the given request. |
protected Object |
getFormBackingObject(HttpServletRequest request)
Returns the object backing the form. |
protected String |
getSessionAttribute(HttpServletRequest request)
Returns the name of the attribute under which the Form is
stored in the HTTP session. |
protected PrintWriter |
getWriter(HttpServletRequest request,
HttpServletResponse response)
|
protected ModelAndView |
handleContentRequest(Form form,
HttpServletRequest request,
HttpServletResponse response)
|
protected ModelAndView |
handleFormRequest(Form form,
HttpServletRequest request,
HttpServletResponse response)
|
protected abstract ModelAndView |
handleFormSubmission(Form form,
HttpServletRequest request,
HttpServletResponse response)
|
ModelAndView |
handleRequest(HttpServletRequest request,
HttpServletResponse response)
Handles a HTTP request. |
protected void |
initController()
|
protected void |
initForm(Form form,
HttpServletRequest request)
Subclasses may overwrite this method to initialize forms after they have been populated. |
protected boolean |
isContentRequest(HttpServletRequest request)
Returns whether the request is to be handled by a ContentElement . |
protected boolean |
isExclusiveRequest(HttpServletRequest request)
|
protected boolean |
isInitialRequest(HttpServletRequest request)
Returns whether the given request is an initial form request. |
protected void |
populateForm(Form form,
HttpServletRequest request)
Populates newly created forms. |
protected void |
processForm(Form form,
HttpServletRequest request)
|
protected void |
removeFormFromSession(HttpServletRequest request)
Removes the Form from the HTTP session. |
protected void |
renderForm(Form form,
PrintWriter writer)
|
void |
setFormContextFactory(FormContextFactory contextFactory)
|
void |
setProcessNewForms(boolean processNewForms)
|
protected ModelAndView |
showForm(Form form,
HttpServletRequest request,
HttpServletResponse response)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String FORM_SUBMISSION_HANDLER
protected static final String BUTTON_CONTAINER_ID
protected RiotLog log
Constructor Detail |
---|
public AbstractFormController()
Method Detail |
---|
public void setFormContextFactory(FormContextFactory contextFactory)
public final void setProcessNewForms(boolean processNewForms)
protected final void initController()
public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception
isInitialRequest(javax.servlet.http.HttpServletRequest)
.
createAndInitForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
in case of an initial request
or getForm(javax.servlet.http.HttpServletRequest)
otherwise.
handleContentRequest(org.riotfamily.forms.Form, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
or handleFormRequest(org.riotfamily.forms.Form, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
.
handleRequest
in interface Controller
Exception
protected ModelAndView handleFormRequest(Form form, HttpServletRequest request, HttpServletResponse response) throws Exception
Exception
protected Form getForm(HttpServletRequest request)
Form
for the given request. By
default this method looks for an existing instance in the HTTP session
under the key returned by getSessionAttribute(javax.servlet.http.HttpServletRequest)
and
returns it.
protected ModelAndView showForm(Form form, HttpServletRequest request, HttpServletResponse response) throws Exception
Exception
protected PrintWriter getWriter(HttpServletRequest request, HttpServletResponse response) throws IOException
IOException
protected void renderForm(Form form, PrintWriter writer)
protected boolean isInitialRequest(HttpServletRequest request)
isContentRequest(javax.servlet.http.HttpServletRequest)
returns false
.
protected boolean isContentRequest(HttpServletRequest request)
ContentElement
.
protected boolean isExclusiveRequest(HttpServletRequest request)
protected ModelAndView handleContentRequest(Form form, HttpServletRequest request, HttpServletResponse response) throws IOException
IOException
protected Form createAndInitForm(HttpServletRequest request, HttpServletResponse response) throws Exception
Exception
protected void processForm(Form form, HttpServletRequest request)
protected void populateForm(Form form, HttpServletRequest request) throws Exception
Form#setValue(Object)
with the object returned by
getFormBackingObject(HttpServletRequest)
.
Exception
protected Object getFormBackingObject(HttpServletRequest request) throws Exception
null
.
Exception
protected abstract Form createForm(HttpServletRequest request)
Form
instance.
protected void initForm(Form form, HttpServletRequest request)
protected final ModelAndView createModelAndView(Form form, HttpServletRequest request, HttpServletResponse response) throws Exception
Exception
protected abstract ModelAndView handleFormSubmission(Form form, HttpServletRequest request, HttpServletResponse response) throws Exception
Exception
protected String getSessionAttribute(HttpServletRequest request)
Form
is
stored in the HTTP session.
protected void removeFormFromSession(HttpServletRequest request)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |