org.jboss.portal.portlet.impl.jsr168.taglib
Class ActionURLTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.jboss.portal.portlet.impl.jsr168.taglib.PortletTag
          extended by org.jboss.portal.portlet.impl.jsr168.taglib.ActionURLTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ActionURLTag
extends PortletTag

The actionURL tag for the JSR 168 Portlet specification.

Creates a URL that must point to the current portlet and must trigger an action request with the supplied parameters.

Version:
$Revision: 5448 $
Author:
Sherman Wood
See Also:
Serialized Form

Field Summary
static java.lang.String typeParameter
           
 
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
ActionURLTag()
           
 
Method Summary
 void addParameter(java.lang.String name, java.lang.String value)
          Add a named parameter.
 int doEndTag()
          Generate the URL
 int doStartTag()
          Process the body, which may contain portlet:param tags
 java.lang.String getPortletMode()
          Indicates the portlet mode that the portlet must have when this link is executed.
 java.lang.String getSecure()
          Indicates whether the resulting URL should be a secure or insecure connection.
protected  java.lang.String getTypeValue()
          Get the type - action or render - from the implementing subclass
 java.lang.String getVar()
           
 java.lang.String getWindowState()
          Indicates the window state that the portlet should have when this link is executed.
 void setPortletMode(java.lang.String portletMode)
           
 void setSecure(java.lang.String secure)
           
 void setVar(java.lang.String var)
           
 void setWindowState(java.lang.String windowState)
           
 
Methods inherited from class org.jboss.portal.portlet.impl.jsr168.taglib.PortletTag
getConfig, getDispatchedRequest, getInvocation, getRequest, getResponse
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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

typeParameter

public static java.lang.String typeParameter
Constructor Detail

ActionURLTag

public ActionURLTag()
Method Detail

getTypeValue

protected java.lang.String getTypeValue()
Get the type - action or render - from the implementing subclass

Returns:
the value for the "type" portal parameter

getPortletMode

public java.lang.String getPortletMode()
Indicates the portlet mode that the portlet must have when this link is executed.

Predefined states: edit, view, help

Optional. Defaults to same as the portlet mode for the current request, by not being included as a parameter in the URL.

Returns:
Returns the portletMode.

setPortletMode

public void setPortletMode(java.lang.String portletMode)
Parameters:
portletMode - The portletMode to set.

getSecure

public java.lang.String getSecure()
Indicates whether the resulting URL should be a secure or insecure connection.

"true" or "false"

Optional. Defaults to security setting for the current request, by not being included as a parameter in the URL.

Returns:
Returns the secure connection value.

setSecure

public void setSecure(java.lang.String secure)
Parameters:
secure - The secure connection value to set.

getVar

public java.lang.String getVar()
Returns:
Returns the var - name of the exported scope variable.

setVar

public void setVar(java.lang.String var)
Parameters:
var - The var to set.

getWindowState

public java.lang.String getWindowState()
Indicates the window state that the portlet should have when this link is executed.

Predefined states: minimized, maximized, normal

Optional. Defaults to same as the window state for the current request, by not being included as a parameter in the URL.

Returns:
Returns the windowState.

setWindowState

public void setWindowState(java.lang.String windowState)
Parameters:
windowState - The windowState to set.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
Add a named parameter. Cater for multiple parameters with the same name by storing them in a list.

Parameters:
name -
value -

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Process the body, which may contain portlet:param tags

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Generate the URL

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException