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

Class DisabledAction

java.lang.Object

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

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

public final class DisabledAction
extends FormAction

A FormAction used to denote a disabled (but present) action.

Constructor Summary

Constructors

Constructor and Description
DisabledAction()

Method Summary

Modifier and Type	Method and Description
FormResult	action(Form f) Perform the actual action based on the form parameters.
java.lang.String	getHelp() Return an optional help text for this action that can be presented as a tooltip etc.
void	setHelp(java.lang.String help)

Methods inherited from class uk.ac.ed.epcc.webapp.forms.action.FormAction

getConfirm, getConfirmMessage, getMustValidate, getShortcut, getText, setConfirm, setConfirmArgs, setMustValidate, setNewWindow, wantNewWindow

Methods inherited from class java.lang.Object

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

Constructor Detail

DisabledAction

public DisabledAction()

Method Detail

action

public FormResult action(Form f)
                  throws ActionException

Description copied from class: FormAction

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.

Specified by:

action in class FormAction

Parameters:

f - Form

Returns:

FormResult

Throws:

ActionException

setHelp

public void setHelp(java.lang.String help)

getHelp

public java.lang.String getHelp()

Description copied from class: FormAction

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

Overrides:

getHelp in class FormAction

Returns:

String or null