xdoclet.modules.apache.struts

Class StrutsFormTagsHandler


public class StrutsFormTagsHandler
extends EjbTagsHandler

Version:
$Revision: 1.13 $
Author:
Dmitri Colebatch (dim@bigpond.net.au)
xdoclet.taghandler
namespace = "StrutsForm"
created
Oct 19, 2001

Field Summary

Fields inherited from class xdoclet.modules.ejb.EjbTagsHandler

ALL, LOCAL_SUFFIX, SERVICE_ENDPOINT, SERVICE_ENDPOINT_SUFFIX

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

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".

Methods inherited from class xdoclet.modules.ejb.EjbTagsHandler

beanType, choosePackage, concreteFullClassName, ejbExternalRefName, ejbName, ejbRefName, ejbRefName, extendsFromFor, forAllBeans, getDependentClassFor, getDependentClassTagName, getEjb, getEjbIdFor, getEjbNameFor, getEjbSpec, getShortEjbNameFor, hasTransaction, id, ifIsAConcreteEJBean, ifLocalEjb, ifNotLocalEjb, ifNotRemoteEjb, ifNotServiceEndpointEjb, ifRemoteEjb, ifServiceEndpointEjb, isAConcreteEJBean, isEjb, isLocalEjb, isOnlyLocalEjb, isOnlyRemoteEjb, isOnlyServiceEndpointEjb, isRemoteEjb, isServiceEndpointEjb, prefixWithEjbSlash, shortEjbName, shouldTraverseSuperclassForDependentClass, symbolicClassName

Methods inherited from class xdoclet.XDocletTagSupport

delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Methods inherited from class xdoclet.template.TemplateTagHandler

getXJavaDoc, setXJavaDoc

Method Details

forAllFormFields

public void forAllFormFields(String template)
            throws xdoclet.XDocletException
Evaluates body for all fields included in form generation
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "block"

getStrutsFormClassFor

public static String getStrutsFormClassFor(XClass clazz)
            throws xdoclet.XDocletException
Gets the StrutsFormClassFor attribute of the StrutsFormTagsHandler class.
Parameters:
clazz - Describe what the parameter does
Returns:
The StrutsFormClassFor value
Throws:
xdoclet.XDocletException - Describe the exception

getStrutsFormClassName

public static String getStrutsFormClassName(XClass clazz)
            throws xdoclet.XDocletException
Gets the StrutsFormClassName attribute of the StrutsFormTagsHandler class
Parameters:
clazz - Describe what the parameter does
Returns:
The StrutsFormClassName value
Throws:
xdoclet.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)
            throws xdoclet.XDocletException
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:
xdoclet.XDocletException - Description of Exception

ifUseMethodInForm

public void ifUseMethodInForm(String template)
            throws xdoclet.XDocletException
Evaluates the body if the method belongs in a given form.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

strutsFormClass

public String strutsFormClass()
            throws xdoclet.XDocletException
Return the class name for the current class.
Returns:
Description of the Returned Value
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"

strutsFormName

public String strutsFormName()
            throws xdoclet.XDocletException
Returns:
Description of the Returned Value
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"

useMethodInForm

protected boolean useMethodInForm(XMethod method)
            throws xdoclet.XDocletException
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:
xdoclet.XDocletException - Description of Exception