org.openmrs.web.taglib

Class FieldGenTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.openmrs.web.taglib.FieldGenTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class FieldGenTag
extends javax.servlet.jsp.tagext.TagSupport

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INPUT_CHAR_LENGTH
static String	DEFAULT_INPUT_FLOAT_LENGTH
static String	DEFAULT_INPUT_INT_LENGTH
static String	DEFAULT_INPUT_TEXT_LENGTH
static long	serialVersionUID

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
FieldGenTag()

Method Summary

Modifier and Type	Method and Description
int	doStartTag()
Boolean	getAllowUserDefault()
String	getFormFieldName()
FieldGenHandler	getHandlerByClassName(String className)
javax.servlet.jsp.PageContext	getPageContext()
Map<String,Object>	getParameterMap()
String	getParameters()
String	getType()
Object	getVal() This is the initial value or the stored value for this tag.
void	setAllowUserDefault(Boolean allowUserDefault) If this is set to true, the user's stored default value for this value will be used if the getVal() is null.
void	setFormFieldName(String formFieldName)
void	setParameterMap(Map<String,Object> parameterMap)
void	setParameters(String parameters)
void	setType(String type)
void	setUrl(String url)
void	setVal(Object startVal)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

DEFAULT_INPUT_TEXT_LENGTH

public static final String DEFAULT_INPUT_TEXT_LENGTH

See Also:

Constant Field Values

DEFAULT_INPUT_INT_LENGTH

public static final String DEFAULT_INPUT_INT_LENGTH

See Also:

Constant Field Values

DEFAULT_INPUT_FLOAT_LENGTH

public static final String DEFAULT_INPUT_FLOAT_LENGTH

See Also:

Constant Field Values

DEFAULT_INPUT_CHAR_LENGTH

public static final String DEFAULT_INPUT_CHAR_LENGTH

See Also:

Constant Field Values

Constructor Detail

FieldGenTag

public FieldGenTag()

Method Detail

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

getType

public String getType()

setType

public void setType(String type)

getFormFieldName

public String getFormFieldName()

Returns:

Returns the formFieldName.

setFormFieldName

public void setFormFieldName(String formFieldName)

Parameters:

formFieldName - The formFieldName to set.

getVal

public Object getVal()

This is the initial value or the stored value for this tag.

Returns:

Returns the startVal.

setVal

public void setVal(Object startVal)

Parameters:

startVal - The startVal to set.

setUrl

public void setUrl(String url)

getParameterMap

public Map<String,Object> getParameterMap()

Returns:

Returns the parameterMap.

setParameterMap

public void setParameterMap(Map<String,Object> parameterMap)

Parameters:

parameterMap - The parameterMap to set.

getParameters

public String getParameters()

Returns:

Returns the parameters.

setParameters

public void setParameters(String parameters)

Parameters:

parameters - The parameters to set.

getAllowUserDefault

public Boolean getAllowUserDefault()

Returns:

the allowUserDefault

setAllowUserDefault

public void setAllowUserDefault(Boolean allowUserDefault)

If this is set to true, the user's stored default value for this value will be used if the getVal() is null.

Usage of this is up to the individual handlers. See LocationHandler for an example.

An example of when the dev doesn't want a default value is if location is set to null by a previous user and the current user is only editing. Therefore, the FieldGenTag.java#setAllowUserDefault() should only be set to true if creating an object for the first time)

Parameters:

allowUserDefault - the allowUserDefault to set

getHandlerByClassName

public FieldGenHandler getHandlerByClassName(String className)