| com.methodhead.auth.AuthAction
 com.methodhead.aikp.AikpAction
All known Subclasses: com.methodhead.reg.UserAction, com.methodhead.shim.HtmlFragmentAction, com.methodhead.sitecontext.SiteContextAction,
| AikpAction | | abstract public class AikpAction extends AuthAction (Code) | |
An Struts action with which to build a web interface for
com.methodhead.aikp.AutoIntKeyPersistableAutoIntKeyPersistable s. This action will perform the following
operations: new, edit, save, and delete. Methods for these operations
and a number of support methods can be overloaded to achieve more
sophisticated behaviour.
Using this action requires at least this Struts configuration:
<![CDATA[
<form-bean
name ="yourObjectForm"
dynamic="true"
type ="com.methodhead.aikp.AikpForm">
<form-property name="action" type="java.lang.String"/>
<form-property name="id" type="java.lang.String"/>
<form-property name="submit" type="java.lang.String"/>
<form-property name="cancel" type="java.lang.String"/>
<form-property name="delete" type="java.lang.String"/>
<form-property name="list" type="java.util.List"/>
<!--
- properties for your object's field...
-->
</form-bean>
<action-mappings>
<action
path ="/yourObject"
type ="com.methodhead.aikp.AikpAction"
parameter="com.your.Policy"
name ="yourObjectForm"
scope ="request"
input ="/yourObject.jsp"
validate ="true">
<forward name="list" path="/yourObjectList.jsp"/>
</action>
</action-mappings>
]]>
In addition, the following message resources should be defined:
<![CDATA[
aikpaction.confirm=Delete {0}?
aikpaction.deleted=Deleted {0}.
aikpaction.saved=Saved {0}.
]]>
What operation is performed depends on the action parameter
(and sometimes the submit parameter). A minimal form looks
like:
<![CDATA[
<%@ page import="com.methodhead.aikp.AikpForm"%>
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>
<html:errors/>
<html:form action="/yourObject">
<html:hidden property="id"/>
<html:hidden property="action"/>
<!--
- inputs for your object...
-->
<input type="submit" name="submit" value="Submit"></input> <%
if ( !form.get( "action" ).equals( "saveNew" ) ) { %>
<input type="submit" name="submit" value="Delete"></input> <%
} %>
</html:form>
]]>
A minimal list form looks like:
<![CDATA[
<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html"%>
<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean"%>
<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic"%>
<logic:iterate
name="yourObjectForm"
property="list"
id="yourObject"
type="com.your.Object">
<a href="yourObject.do-action=edit&id=--= yourObject.get( "id" ) %>"><%= yourObject.get( "yourField" ) %></a><br>
</logic:iterate>
]]>
|
| Method Summary | |
| abstract protected AutoIntKeyPersistable | createPersistable(OperationContext op)
Returns a new instance of the persistable to be managed by this action. | | protected ActionForward | doCancel(OperationContext op, Object policy)
Like doEdit(), doCancel() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input. | | protected ActionForward | doCancelDelete(OperationContext op, Object policy)
Like doEdit(), doCancelDelete() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input. | | protected ActionForward | doCancelSave(OperationContext op, Object policy)
Like doEdit(), doCancelSave() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input. | | protected ActionForward | doCancelSaveNew(OperationContext op, Object policy)
| | protected ActionForward | doConfirm(OperationContext op, Object policy)
Called when an persistable is to be deleted, adds the
aikpaction.confirm to the action's messages (accessible by the
Struts html:messages tag) and returns a forward to
confirm. | | protected ActionForward | doDelete(OperationContext op, Object policy)
Loads the persistable using the form's id property, and invokes
its delete() method; a the status forward is returned.
The aikpaction.deleted message is added to the action's messages
(accessible by the Struts html:messages tag). | | protected ActionForward | doEdit(OperationContext op, Object policy)
Loads the persistable using the form's id property and uses its
field values to initialize the form; a forward to input is returned. | | public ActionForward | doExecute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
Executes the action, calling the appropriate method (doNew(),
doEdit(), etc.) according to the form's properties. | | protected ActionForward | doList(OperationContext op, Object policy)
Loads all elements from the database using
AutoIntKeyPersistable.loadAll loadAll() and forwards to list. | | protected ActionForward | doNew(OperationContext op, Object policy)
Uses the persistable's default values to initialize the form; a forward to
input is returned. | | protected ActionForward | doSave(OperationContext op, Object policy)
Loads the persistable using the form's id property, sets its
fields, and calls its save() method. | | protected ActionForward | doSaveNew(OperationContext op, Object policy)
Creates the persistable, sets its fields and calls its saveNew()
method. | | protected ActionForward | getForwardForDelete(OperationContext op, Object policy)
Returns the forward used when the persistable is deleted; by default, a
the status forward is returned. | | protected ActionForward | getForwardForSave(OperationContext op, Object policy)
Returns the forward used when the persistable is saved; by default, a
forward to input is returned. | | protected void | populateForm(DynaActionForm form, AutoIntKeyPersistable persistable)
Populates the form with persistable's field values. | | protected static void | populateFormProperty(String name, DynaActionForm form, AutoIntKeyPersistable persistable)
Populates the specified form property with the corresponding value from
persistable using it's toString() method (unless it's a
date, in which case it is formatted with DateFormat.getDateInstance(
DateFormat.SHORT )). | | protected void | populatePersistable(AutoIntKeyPersistable persistable, DynaActionForm form)
Populates the persistable's field values with form. | | protected static void | populatePersistableField(String name, AutoIntKeyPersistable persistable, DynaActionForm form)
Populates the specified persistable property with the corresponding
property from form, using
com.methodhead.persistable.Persistable.setAsObjectPersistable.setAsObject() to set the value. |
| doCancel | | protected ActionForward doCancel(OperationContext op, Object policy)(Code) | | Like doEdit(), doCancel() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input.
AikpAction.doCancelDelete |
| doCancelDelete | | protected ActionForward doCancelDelete(OperationContext op, Object policy)(Code) | | Like doEdit(), doCancelDelete() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input.
|
| doCancelSave | | protected ActionForward doCancelSave(OperationContext op, Object policy)(Code) | | Like doEdit(), doCancelSave() loads the persistable using
the form's id property, populates the form, adds the
aikpaction.cancelled message to the action, and returns a forward
to input.
|
| doConfirm | | protected ActionForward doConfirm(OperationContext op, Object policy)(Code) | |
Called when an persistable is to be deleted, adds the
aikpaction.confirm to the action's messages (accessible by the
Struts html:messages tag) and returns a forward to
confirm. Note: The persistable itself is argument 0 to
the message, so make sure its toString() method returns
something reasonable if you include {0} in your message.
|
| doDelete | | protected ActionForward doDelete(OperationContext op, Object policy)(Code) | |
Loads the persistable using the form's id property, and invokes
its delete() method; a the status forward is returned.
The aikpaction.deleted message is added to the action's messages
(accessible by the Struts html:messages tag). Note: The
persistable itself is argument 0 to the message, so make sure its
toString() method returns something reasonable if you include
{0} in your message.
|
| doEdit | | protected ActionForward doEdit(OperationContext op, Object policy)(Code) | | Loads the persistable using the form's id property and uses its
field values to initialize the form; a forward to input is returned.
|
| doExecute | | public ActionForward doExecute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)(Code) | | Executes the action, calling the appropriate method (doNew(),
doEdit(), etc.) according to the form's properties.
|
| doNew | | protected ActionForward doNew(OperationContext op, Object policy)(Code) | | Uses the persistable's default values to initialize the form; a forward to
input is returned.
|
| doSave | | protected ActionForward doSave(OperationContext op, Object policy)(Code) | | Loads the persistable using the form's id property, sets its
fields, and calls its save() method. The form is then
repopulated with values from the saved persistable. The
aikpaction.saved message is added to the action and a forward to
input is returned.
|
| doSaveNew | | protected ActionForward doSaveNew(OperationContext op, Object policy)(Code) | | Creates the persistable, sets its fields and calls its saveNew()
method. The form is then repopulated with values from the saved
persistable. The aikpaction.saved message is added to the action
and a forward to input is returned.
|
| getForwardForDelete | | protected ActionForward getForwardForDelete(OperationContext op, Object policy)(Code) | | Returns the forward used when the persistable is deleted; by default, a
the status forward is returned.
|
| getForwardForSave | | protected ActionForward getForwardForSave(OperationContext op, Object policy)(Code) | | Returns the forward used when the persistable is saved; by default, a
forward to input is returned.
|
| populateForm | | protected void populateForm(DynaActionForm form, AutoIntKeyPersistable persistable)(Code) | | Populates the form with persistable's field values. All
form fields are expected to be of type String.
|
| populateFormProperty | | protected static void populateFormProperty(String name, DynaActionForm form, AutoIntKeyPersistable persistable)(Code) | | Populates the specified form property with the corresponding value from
persistable using it's toString() method (unless it's a
date, in which case it is formatted with DateFormat.getDateInstance(
DateFormat.SHORT )).
|
| populatePersistable | | protected void populatePersistable(AutoIntKeyPersistable persistable, DynaActionForm form)(Code) | | Populates the persistable's field values with form. All
form fields are expected to be of type String. Date fields are
parsed using a DateFormat as returned by
DateFormat.getDateTimeInstance().
|
|
|