org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.tags
Class XURLTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.tags.XURLTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ActionURLTag, RenderURLTag, ResourceURLTag

public abstract class XURLTag
extends javax.servlet.jsp.tagext.BodyTagSupport

Created by The eXo Platform SAS. Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: Aug 20, 2003 Time: 2:00:32 PM

See Also:

Serialized Form

Field Summary

protected boolean	copyCurrentRenderParameters Copy current render parameters.
protected boolean	escapeXml Escape xml value.
protected javax.portlet.PortletMode	portletMode Portlet mode.
protected java.lang.String	resourceCacheability Resource cacheability.
protected java.lang.String	resourceID Resource id.
protected boolean	secure Secure.
protected java.lang.String	var Var name.
protected javax.portlet.WindowState	windowState Window state.

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

XURLTag()

Method Summary

void	addParameter(java.lang.String key, java.lang.String value)
protected void	addParameters(java.lang.String key, java.lang.String[] values)
void	addProperty(java.lang.String key, java.lang.String value)
int	doEndTag() Overridden method.
int	doStartTag() Overridden method.
abstract javax.portlet.BaseURL	getPortletURL()
void	setCacheability(java.lang.String resourceCacheability)
void	setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)
void	setEscapeXml(boolean escapeXml)
void	setId(java.lang.String resourceID) Overridden method.
void	setPortletMode(java.lang.String portletMode)
void	setProperties(javax.portlet.BaseURL url, java.util.Map<java.lang.String,java.lang.String[]> map)
void	setSecure(java.lang.String secure)
void	setVar(java.lang.String var)
void	setWindowState(java.lang.String windowState)
java.lang.String	URLToString(javax.portlet.BaseURL baseURL) Returns the portlet URL string representation to be embedded in the markup.

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

findAncestorWithClass, getId, 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

windowState

protected javax.portlet.WindowState windowState

Window state.

portletMode

protected javax.portlet.PortletMode portletMode

Portlet mode.

var

protected java.lang.String var

Var name.

secure

protected boolean secure

Secure.

copyCurrentRenderParameters

protected boolean copyCurrentRenderParameters

Copy current render parameters.

escapeXml

protected boolean escapeXml

Escape xml value.

resourceID

protected java.lang.String resourceID

Resource id.

resourceCacheability

protected java.lang.String resourceCacheability

Resource cacheability.

Constructor Detail

XURLTag

public XURLTag()

Method Detail

addParameter

public final void addParameter(java.lang.String key,
                               java.lang.String value)

Parameters:

key - key

value - value

addParameters

protected void addParameters(java.lang.String key,
                             java.lang.String[] values)

Parameters:

key - key

values - values

addProperty

public final void addProperty(java.lang.String key,
                              java.lang.String value)

Parameters:

key - key

value - value

setProperties

public final void setProperties(javax.portlet.BaseURL url,
                                java.util.Map<java.lang.String,java.lang.String[]> map)

Parameters:

url - url

map - url properties

setWindowState

public final void setWindowState(java.lang.String windowState)

Parameters:

windowState - window state

setPortletMode

public final void setPortletMode(java.lang.String portletMode)

Parameters:

portletMode - portlet mode

setVar

public final void setVar(java.lang.String var)

Parameters:

var - jsp var name

setSecure

public final void setSecure(java.lang.String secure)

Parameters:

secure - secure

setCopyCurrentRenderParameters

public final void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)

Parameters:

copyCurrentRenderParameters - copy current render parameters

setEscapeXml

public final void setEscapeXml(boolean escapeXml)

Parameters:

escapeXml - escape xml

setId

public final void setId(java.lang.String resourceID)

Overridden method.

Overrides:

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

Parameters:

resourceID - resource id

See Also:

TagSupport.setId(java.lang.String)

setCacheability

public final void setCacheability(java.lang.String resourceCacheability)

Parameters:

resourceCacheability - cacheability

doStartTag

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

Overridden method.

Specified by:

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

Overrides:

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

Returns:

tag result

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doStartTag()

doEndTag

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

Overridden method.

Specified by:

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

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Returns:

tag evaluation resul

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doEndTag()

URLToString

public final java.lang.String URLToString(javax.portlet.BaseURL baseURL)

Returns the portlet URL string representation to be embedded in the markup. The container-runtime-option element may re-define default portlet container behavior, like the javax.portlet.escapeXml setting that disables XML encoding of URLs produced by the portlet tag library as default.

Parameters:

baseURL - base url

Returns:

url string

getPortletURL

public abstract javax.portlet.BaseURL getPortletURL()

Returns:

portlet url