当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档
org.jboss.portal.portlet.impl.jsr168.taglib
GenerateURLTag - JBOSS Portal 2.6 API 英文版文档
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
org.jboss.portal.portlet.impl.jsr168.taglib
Class GenerateURLTag
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
- All Implemented Interfaces:
- javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
- Direct Known Subclasses:
- ActionURLTag, RenderURLTag
- abstract class GenerateURLTag
- extends PortletTag
Superclass of the actionURL and renderURL tags for the JSR 168 Portlet specification.
Creates a URL that must point to the current portlet and must trigger a render or action request with the supplied parameters.
- Version:
- $Revision: 5448 $
- Author:
- Sherman Wood
| Field Summary | |
private java.util.Map |
parameters
|
private java.lang.String |
portletMode
|
private java.lang.String |
secure
|
private java.lang.String |
var
|
private java.lang.String |
windowState
|
| Fields inherited from class org.jboss.portal.portlet.impl.jsr168.taglib.PortletTag |
|
| 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 | |
(package private) |
GenerateURLTag()
|
| Method Summary | |
void |
addParameter(java.lang.String name,
java.lang.String value)
Add a named parameter. |
private void |
clearPreviousTag()
|
int |
doEndTag()
Generate the URL |
int |
doStartTag()
Process the body, which may contain portlet:param tags |
private PortletURL |
getBasePortletEnvironmentAndURL()
Set up the environment for generating the PortletURL and get the base PortletURL to decorate. |
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 abstract java.lang.String |
getTypeValue()
Get the type - action or render - from the implementing subclass |
private java.util.Map |
getURLParameters()
Convert working parameters to what is needed by PortletURL - a map with String[] values. |
java.lang.String |
getVar()
|
java.lang.String |
getWindowState()
Indicates the window state that the portlet should have when this link is executed. |
private void |
setPortletMode(PortletURL portletURL)
Set the portlet mode for the URL to be what was given in the tag. |
void |
setPortletMode(java.lang.String portletMode)
|
private void |
setSecure(PortletURL portletURL)
Set the secure/unsecure state for the URL to be what was given in the tag. |
void |
setSecure(java.lang.String secure)
|
void |
setVar(java.lang.String var)
|
private void |
setWindowState(PortletURL portletURL)
Set the window state for the URL to be what was given in the tag. |
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 |
windowState
private java.lang.String windowState
portletMode
private java.lang.String portletMode
var
private java.lang.String var
secure
private java.lang.String secure
parameters
private java.util.Map parameters
| Constructor Detail |
GenerateURLTag
GenerateURLTag()
| Method Detail |
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.
getURLParameters
private java.util.Map getURLParameters()
- Convert working parameters to what is needed by PortletURL - a map with String[] values.
- Returns:
- Returns the parameters.
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-
getBasePortletEnvironmentAndURL
private PortletURL getBasePortletEnvironmentAndURL()
- Set up the environment for generating the PortletURL and get the base PortletURL to decorate. Includes setting the
"type" parameter from the implementing subclass.
- Returns:
- The PortelURL to decorate
setWindowState
private void setWindowState(PortletURL portletURL) throws WindowStateException
- Set the window state for the URL to be what was given in the tag. If not given, default to what was there
previously
- Parameters:
portletURL-- Throws:
WindowStateException
setPortletMode
private void setPortletMode(PortletURL portletURL) throws PortletModeException
- Set the portlet mode for the URL to be what was given in the tag. If not given, default to what was there
previously
- Parameters:
portletURL-- Throws:
PortletModeException
setSecure
private void setSecure(PortletURL portletURL) throws PortletSecurityException
- Set the secure/unsecure state for the URL to be what was given in the tag. If not given, default to what was there
previously
- Parameters:
portletURL-- Throws:
PortletSecurityException
clearPreviousTag
private void clearPreviousTag()
getTypeValue
protected abstract java.lang.String getTypeValue()
- Get the type - action or render - from the implementing subclass
- Returns:
- the value for the "type" portal parameter
doStartTag
public int doStartTag()
throws javax.servlet.jsp.JspException
- Process the body, which may contain portlet:param tags
- Throws:
javax.servlet.jsp.JspException
doEndTag
public int doEndTag()
throws javax.servlet.jsp.JspException
- Generate the URL
- Throws:
javax.servlet.jsp.JspException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||