uk.ac.ed.epcc.webapp.forms.action

Class FormAction

java.lang.Object

uk.ac.ed.epcc.webapp.forms.action.FormAction

Direct Known Subclasses:

AddFieldTransition.AddFieldAction, AddStdIndexTransition.AddIndexAction, AvatarComposite.AddAvatarTransition.AddAvatarAction, AvatarComposite.AddAvatarTransition.RemoveAvatarAction, ChainAction, CodeAuthTransitionProvider.AuthenticateTransition.ProcessAction, CreateAction, DeleteAction, DisabledAction, DomTransitionProvider.EditAction, DomTransitionProvider.EditNodeAction, DropFieldTransition.DropAction, DropForeignKeyTransition.DropAction, DropIndexTransition.DropAction, DynamicFormTransitionProvider.AddXMLTransition.XMLUploadAction, DynamicFormTransitionProvider.DuplicateTransition.DuplicateAction, EmailChangeRequestFactory.RequestAction, EmailChangeRequestFactory.VerifyAction, EmailTransitionProvider.EditFormAction, ErrorProcessingFormAction, FormState.NextAction, FormState.ResetAction, LogFactory.ItemAction, MoveDateTransition.MoveDateAction, NestAction, PartManager.ChildCreateAction, PartPathTransitionProvider.AddXMLTransition.XMLUploadAction, PartPathTransitionProvider.ConfigTransition.ConfigAction, PartPathTransitionProvider.EditPartTransition.CancelAction, PasswordUpdateFormBuilder.CancelAction, PasswordUpdateFormBuilder.CancelLogoutAction, PasswordUpdateFormBuilder.UpdateAction, PersonalResponseTransitionProvider.CreateTransition.ViewAction, PreferenceTransitionProvider.SetFeatureTransition.SetFeatureAction, PreferenceTransitionProvider.SetPreferenceTransition.SetAction, RelationshipTableCreator.CreateAction, ResponseTransitionProvider.EditSectionTransition.CancelAction, RetireAction, RoleAction, SplitTransition.SplitAction, TextFileOverlay.TextFileDiffAction, TextFileOverlay.TextFileRevertAction, TextFileOverlay.TextFileUpdateAction, TotpCodeAuthComposite.SetToptTransition.setKeyAction, UnRetireAction, UpdateAction, ViewRelationTransition.ShowAction, XMLOverlay.XMLEditAction

public abstract class FormAction
extends java.lang.Object

A formAction represents an action button attached to a form When the button is pressed. Actions can request a yes/no confirm message. If validation is turned off then the state of the form is ignored and the action is run anyway. This is used to implement cancel actions.

Constructor Summary

Constructors

Constructor and Description
FormAction()

Method Summary

Modifier and Type	Method and Description
abstract FormResult	action(Form f) Perform the actual action based on the form parameters.
java.lang.String	getConfirm(Form f) should this action be confirmed before execute If this returns null no confirm is required.
ConfirmMessage	getConfirmMessage(Form f)
java.lang.String	getHelp() Return an optional help text for this action that can be presented as a tooltip etc.
boolean	getMustValidate()
java.lang.String	getShortcut() Return an optional shortcut key for this action.
java.lang.Object	getText() Get optional button content to use instead of the action name.
void	setConfirm(java.lang.String c)
void	setConfirmArgs(java.lang.Object[] args)
void	setMustValidate(boolean validate)
void	setNewWindow(boolean new_window)
boolean	wantNewWindow()

Methods inherited from class java.lang.Object

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

Constructor Detail

FormAction

public FormAction()

Method Detail

wantNewWindow

public boolean wantNewWindow()

setNewWindow

public void setNewWindow(boolean new_window)

action

public abstract FormResult action(Form f)
                           throws ActionException

Perform the actual action based on the form parameters. Throw a TransitionException to show an error message to the user. or a ActionException to produce a generic error message.

Parameters:

f - Form

Returns:

FormResult

Throws:

ActionException

getConfirm

public java.lang.String getConfirm(Form f)

should this action be confirmed before execute If this returns null no confirm is required. If not null it is the name of the confirm message in the confirm.properties

The form is passed to allow a sub-class to trigger confirm based on form parameters. However in this case the implementation must handle an incomplete form. Note that the message can be set by calling setConfirm(String) or this method can be overidden

Parameters:

f - Form calling action.

Returns:

String confirm name

getConfirmMessage

public final ConfirmMessage getConfirmMessage(Form f)

setConfirm

public void setConfirm(java.lang.String c)

setConfirmArgs

public void setConfirmArgs(java.lang.Object[] args)

getHelp

public java.lang.String getHelp()

Return an optional help text for this action that can be presented as a tooltip etc.

Returns:

String or null

getText

public java.lang.Object getText()

Get optional button content to use instead of the action name. This can be a UIProvider or UIGenerator but should not include active content

Returns:

Object to add

getShortcut

public java.lang.String getShortcut()

Return an optional shortcut key for this action.

Returns:

String or null

getMustValidate

public boolean getMustValidate()

setMustValidate

public void setMustValidate(boolean validate)