org.opencms.jsp
Class CmsJspTagLink

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended byorg.opencms.jsp.CmsJspTagLink
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class CmsJspTagLink
extends javax.servlet.jsp.tagext.BodyTagSupport

Implements the <cms:link>[filename]</cms:link> tag to add OpenCms managed links to a JSP page, required for link management and the static export to work properly.

Since:
6.0.0
Version:
$Revision: 1.19 $
Author:
Alexander Kandzior
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, 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
CmsJspTagLink()
           
 
Method Summary
 int doEndTag()
           
static java.lang.String linkTagAction(java.lang.String target, javax.servlet.ServletRequest req)
          Returns a link to a file in the OpenCms VFS that has been adjusted according to the web application path and the OpenCms static export rules.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, 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
 

Constructor Detail

CmsJspTagLink

public CmsJspTagLink()
Method Detail

linkTagAction

public static java.lang.String linkTagAction(java.lang.String target,
                                             javax.servlet.ServletRequest req)
Returns a link to a file in the OpenCms VFS that has been adjusted according to the web application path and the OpenCms static export rules.

Since OpenCms version 7.0.2, you can also use this method in case you are not sure if the link is internal or external, as CmsLinkManager.substituteLinkForUnknownTarget(org.opencms.file.CmsObject, String) is used to calculate the link target.

Relative links are converted to absolute links, using the current element URI as base.

Parameters:
target - the link that should be calculated, can be relative or absolute
req - the current request
Returns:
the target link adjusted according to the web application path and the OpenCms static export rules
See Also:
CmsLinkManager.substituteLinkForUnknownTarget(org.opencms.file.CmsObject, String)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Returns:
EVAL_PAGE
Throws:
javax.servlet.jsp.JspException - in case something goes wrong
See Also:
Tag.doEndTag()