org.apache.pluto.tags
Class PortletURLTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.pluto.tags.BaseURLTag
          extended by org.apache.pluto.tags.PortletURLTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ActionURLTag, RenderURLTag

public abstract class PortletURLTag
extends BaseURLTag

Abstract supporting class for actionURL tag and renderURL tag.

Version:
2.0
See Also:
Serialized Form

Nested Class Summary
static class PortletURLTag.TEI
          TagExtraInfo class for PortletURLTag.
 
Field Summary
protected  java.lang.Boolean copyCurrentRenderParameters
           
protected  java.lang.String portletMode
           
protected  PortletURL url
           
protected  java.lang.String windowState
           
 
Fields inherited from class org.apache.pluto.tags.BaseURLTag
escapeXml, parametersMap, propertiesMap, secure, secureBoolean, var
 
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
PortletURLTag()
           
 
Method Summary
protected abstract  PortletURL createPortletUrl(PortletResponse portletResponse)
          Creates an actionURL or a renderURL
protected  void doCopyCurrentRenderParameters()
          Copies the current render parameters to the parameter map.
 int doEndTag()
           
 int doStartTag()
           
 java.lang.Boolean getCopyCurrentRenderParameters()
          Returns the copyCurrentRenderParameters property.
 java.lang.String getPortletMode()
          Returns the portletMode property.
 PortletURL getUrl()
          Returns the url property.
 java.lang.String getWindowState()
          Returns the windowState property.
 void setCopyCurrentRenderParameters(java.lang.Boolean copyCurrentRenderParameters)
          Sets copyCurrentRenderParameters property.
 void setPortletMode(java.lang.String portletMode)
          Sets the portletMode property.
 void setUrl(PortletURL url)
          Sets the url property.
 void setWindowState(java.lang.String windowState)
          Sets the windowState property.
 
Methods inherited from class org.apache.pluto.tags.BaseURLTag
addParameter, addProperty, doEscapeXml, getEscapeXml, getSecure, getSecureBoolean, getVar, release, setEscapeXml, setSecure, setUrlParameters, setUrlProperties, setVar
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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
 

Field Detail

portletMode

protected java.lang.String portletMode

windowState

protected java.lang.String windowState

copyCurrentRenderParameters

protected java.lang.Boolean copyCurrentRenderParameters

url

protected PortletURL url
Constructor Detail

PortletURLTag

public PortletURLTag()
Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Specified by:
doStartTag in class BaseURLTag
Throws:
javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Specified by:
doEndTag in class BaseURLTag
Throws:
javax.servlet.jsp.JspException

getUrl

public PortletURL getUrl()
Returns the url property.

Returns:
PortletURL

getPortletMode

public java.lang.String getPortletMode()
Returns the portletMode property.

Returns:
String

getWindowState

public java.lang.String getWindowState()
Returns the windowState property.

Returns:
String

getCopyCurrentRenderParameters

public java.lang.Boolean getCopyCurrentRenderParameters()
Returns the copyCurrentRenderParameters property.

Returns:
Boolean

setUrl

public void setUrl(PortletURL url)
Sets the url property.

Parameters:
url - The url to set

setPortletMode

public void setPortletMode(java.lang.String portletMode)
Sets the portletMode property.

Parameters:
portletMode - - the portlet mode to set

setWindowState

public void setWindowState(java.lang.String windowState)
Sets the windowState property.

Parameters:
windowState - - the portlet window state to set

setCopyCurrentRenderParameters

public void setCopyCurrentRenderParameters(java.lang.Boolean copyCurrentRenderParameters)
Sets copyCurrentRenderParameters property.

Parameters:
copyCurrentRenderParameters -

doCopyCurrentRenderParameters

protected void doCopyCurrentRenderParameters()
Copies the current render parameters to the parameter map.


createPortletUrl

protected abstract PortletURL createPortletUrl(PortletResponse portletResponse)
Creates an actionURL or a renderURL

Parameters:
portletResponse - PortletResponse
Returns:
PortletURL


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.