xdoclet.modules.apache.struts

Class StrutsFormTagsHandler

public class StrutsFormTagsHandler extends EjbTagsHandler

Version: $Revision: 1.13 $

Author: Dmitri Colebatch (dim@bigpond.net.au)

UNKNOWN: Oct 19, 2001 namespace = "StrutsForm"

Method Summary
void	forAllFormFields(String template) Evaluates body for all fields included in form generation
static String	getStrutsFormClassFor(XClass clazz) Gets the StrutsFormClassFor attribute of the StrutsFormTagsHandler class.
static String	getStrutsFormClassName(XClass clazz) Gets the StrutsFormClassName attribute of the StrutsFormTagsHandler class
protected static String	getStrutsFormClassPattern() Gets the StrutsFormClassPattern attribute of the StrutsFormTagsHandler class
static boolean	hasFormDefinition(XClass clazz) Return true if at least one struts:form tag is defined.
void	ifUseMethodInForm(String template) Evaluates the body if the method belongs in a given form.
String	strutsFormClass() Return the class name for the current class.
String	strutsFormName()
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".

Method Detail

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"

getStrutsFormClassFor

public static String getStrutsFormClassFor(XClass clazz)

Gets the StrutsFormClassFor attribute of the StrutsFormTagsHandler class.

Parameters: clazz Describe what the parameter does

Returns: The StrutsFormClassFor value

Throws: XDocletException Describe the exception

getStrutsFormClassName

public static String getStrutsFormClassName(XClass clazz)

Gets the StrutsFormClassName attribute of the StrutsFormTagsHandler class

Parameters: clazz Describe what the parameter does

Returns: The StrutsFormClassName value

Throws: XDocletException Describe the exception

getStrutsFormClassPattern

protected static String getStrutsFormClassPattern()

Gets the StrutsFormClassPattern attribute of the StrutsFormTagsHandler class

Returns: The StrutsFormClassPattern 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"

strutsFormClass

public String strutsFormClass()

Return the class name for the current class.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

strutsFormName

public String strutsFormName()

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

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