org.openmrs.web.taglib

Class PortletTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.apache.taglibs.standard.tag.common.core.ImportSupport

org.openmrs.web.taglib.PortletTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally, org.apache.taglibs.standard.tag.common.core.ParamParent

public class PortletTag
extends org.apache.taglibs.standard.tag.common.core.ImportSupport

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.apache.taglibs.standard.tag.common.core.ImportSupport

charEncoding, context, DEFAULT_ENCODING, url, VALID_SCHEME_CHARS

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

bodyContent

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

pageContext

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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
PortletTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag()
protected String	generatePortletUrl(String portletUrl, String moduleId) Generates the portlet url.
Integer	getEncounterId()
String	getId()
String	getModuleId()
javax.servlet.jsp.PageContext	getPageContext()
Map<String,Object>	getParameterMap()
String	getParameters()
Integer	getPatientId()
String	getPatientIds()
Integer	getPersonId()
String	getSize()
Integer	getUserId()
void	setEncounterId(Integer encounterId)
void	setId(String id)
void	setModuleId(String moduleId)
void	setParameterMap(Map<String,Object> parameterMap)
void	setParameters(String parameters)
void	setPatientId(Integer patientId)
void	setPatientIds(String patientIds)
void	setPersonId(Integer personId)
void	setSize(String size)
void	setUrl(String url)
void	setUserId(Integer userId)

Methods inherited from class org.apache.taglibs.standard.tag.common.core.ImportSupport

addParameter, doCatch, doFinally, isAbsoluteUrl, release, setScope, setVar, setVarReader, stripSession

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

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

getParent, setPageContext, setParent

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PortletTag

public PortletTag()

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 org.apache.taglibs.standard.tag.common.core.ImportSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class org.apache.taglibs.standard.tag.common.core.ImportSupport

Throws:

javax.servlet.jsp.JspException

generatePortletUrl

protected String generatePortletUrl(String portletUrl,
                                    String moduleId)

Generates the portlet url.

• Core portlets are expected to be in the /WEB-INF/view/portlets/ folder.
• Module portlets are expected to be in the /WEB-INF/view/module/moduleId/portlets/ folder.

Parameters:

portletUrl - The portlet url.

moduleId - The optional portlet module id.

Returns:

The url for the portlet.

Expected Behavior:

Should return the correct url for a core portlet

Should return the correct url for a module portlet

Should replace period in a module id with a forward slash when building a module portlet url

Should not update the moduleId field for a module portlet

Should return a core portlet url when the specified module cannot be found

Should append .portlet to the url if not specified

Should treat both an empty and null module id as core portlets

setUrl

public void setUrl(String url)
            throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

getId

public String getId()

Overrides:

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

setId

public void setId(String id)

Overrides:

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

getParameters

public String getParameters()

setParameters

public void setParameters(String parameters)

getSize

public String getSize()

setSize

public void setSize(String size)

getEncounterId

public Integer getEncounterId()

setEncounterId

public void setEncounterId(Integer encounterId)

getPatientId

public Integer getPatientId()

setPatientId

public void setPatientId(Integer patientId)

getPersonId

public Integer getPersonId()

setPersonId

public void setPersonId(Integer personId)

getPatientIds

public String getPatientIds()

setPatientIds

public void setPatientIds(String patientIds)

getUserId

public Integer getUserId()

setUserId

public void setUserId(Integer userId)

getParameterMap

public Map<String,Object> getParameterMap()

setParameterMap

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

getModuleId

public String getModuleId()

setModuleId

public void setModuleId(String moduleId)