xdoclet.modules.apache.struts

Class ActionFormTagsHandler

public class ActionFormTagsHandler extends XDocletTagSupport

Version: $Revision: 1.2 $

Author: Matt Raible (matt@raibledesigns.com)

UNKNOWN: April 26, 2004 namespace = "ActionForm"

Method Summary
StringactionFormClass()
Return the class name for the current class.
StringactionFormName()
voidforAllFormFields(String template)
Evaluates body for all fields included in form generation
static StringgetActionFormClassFor(XClass clazz)
Gets the ActionFormClassFor attribute of the ActionFormTagsHandler class.
static StringgetActionFormClassName(XClass clazz)
Gets the ActionFormClassName attribute of the ActionFormTagsHandler class
protected static StringgetActionFormClassPattern()
Gets the ActionFormClassPattern attribute of the ActionFormTagsHandler class
static booleanhasFormDefinition(XClass clazz)
Return true if at least one struts:form tag is defined.
voidifUseMethodInForm(String template)
Evaluates the body if the method belongs in a given form.
protected booleanuseMethodInForm(XMethod method)
Check that method has struts:form-field tag with valid name, or is pk field (and pk fields are included) or include-all="true".

Method Detail

actionFormClass

public String actionFormClass()
Return the class name for the current class.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

actionFormName

public String actionFormName()

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

forAllFormFields

public void forAllFormFields(String template)
Evaluates body for all fields included in form generation

Parameters: template The body of the block tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block"

getActionFormClassFor

public static String getActionFormClassFor(XClass clazz)
Gets the ActionFormClassFor attribute of the ActionFormTagsHandler class.

Parameters: clazz Describe what the parameter does

Returns: The ActionFormClassFor value

Throws: XDocletException Describe the exception

getActionFormClassName

public static String getActionFormClassName(XClass clazz)
Gets the ActionFormClassName attribute of the ActionFormTagsHandler class

Parameters: clazz Describe what the parameter does

Returns: The ActionFormClassName value

Throws: XDocletException Describe the exception

getActionFormClassPattern

protected static String getActionFormClassPattern()
Gets the ActionFormClassPattern attribute of the ActionFormTagsHandler class

Returns: The ActionFormClassPattern value

hasFormDefinition

public static boolean hasFormDefinition(XClass clazz)
Return true if at least one struts:form tag is defined.

Parameters: clazz Class to check

Returns: whether class has struts:form tag defined

Throws: XDocletException Description of Exception

ifUseMethodInForm

public void ifUseMethodInForm(String template)
Evaluates the body if the method belongs in a given form.

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

useMethodInForm

protected boolean useMethodInForm(XMethod method)
Check that method has struts:form-field tag with valid name, or is pk field (and pk fields are included) or include-all="true".

Parameters: method Description of Parameter

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception