WebSphere Portal: Generating output

JSP tags of the IBM Portlet API

+
Search Tips | Advanced Search

Overview

The portlet container provides IBM Portlet API JSP tags. To use, put the following directive at the beginning of your JSP:
<%@ taglib uri="/WEB-INF/tld/portlet.tld" prefix="portletAPI" %>

Note that these tags are not available if you use the getRequestDispatcher() method of the servlet API to invoke the JSP. Rather, use the PortletContext.include() method of the IBM Portlet API.
The following is a brief description of each tag.

Tag Description
<portletAPI:if /> Through the attributes of this tag, several conditions can be checked. If the condition is true, the content of the tag is written to the page.
<portletAPI:log /> Writes a string in the portlet log.
<portletAPI:bidi /> This tag is used to support text for bidirectional languages.
<portletAPI:dataLoop /> Loops through all attributes in PortletData of the current concrete portlet instance.
<portletAPI:dataAttribute /> Returns the value of one or more PortletData attributes.
<portletAPI:settingsLoop /> Loops through all attributes in PortletSettings of the current concrete portlet.
<portletAPI:settingsAttribute /> Returns the value of one or more PortletSettings attributes.
<portletAPI:CreateReturnURI /> Creates a URI that points to the caller of the portlet.
<portletAPI:createURI /> Creates an URI that points to the current portlet with the given parameters.
<portletAPI:URIParameter /> Adds a parameter to the URI of the createURI and CreateReturnURI tags.
<portletAPI:URIAction /> Adds a default action to the URI of the createURI and createReturnURI tags.
<portletAPI:encodeNamespace /> Maps the given string value into this portlet's namespace.
<portletAPI:init /> Provides access to the portletRequest, portletResponse, and portletConfig objects.

Deprecated portlet JSP tags

The following tags have been deprecated.

Deprecated tag Replacement
<portletAPI:encodeURI/> encodeURL() method of the ServletResponse
<portletAPI:text/> <fmt:message/> and <fmt:bundle/> tags of the Java Standard Tag Library (JSTL). See Using JSTL in portlet JSPs for more information.

See also

Detailed descriptions of the Portlet API tags
Generating output

Home |

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.

Tag	Description
<portletAPI:if />	Through the attributes of this tag, several conditions can be checked. If the condition is true, the content of the tag is written to the page.
<portletAPI:log />	Writes a string in the portlet log.
<portletAPI:bidi />	This tag is used to support text for bidirectional languages.
<portletAPI:dataLoop />	Loops through all attributes in PortletData of the current concrete portlet instance.
<portletAPI:dataAttribute />	Returns the value of one or more PortletData attributes.
<portletAPI:settingsLoop />	Loops through all attributes in PortletSettings of the current concrete portlet.
<portletAPI:settingsAttribute />	Returns the value of one or more PortletSettings attributes.
<portletAPI:CreateReturnURI />	Creates a URI that points to the caller of the portlet.
<portletAPI:createURI />	Creates an URI that points to the current portlet with the given parameters.
<portletAPI:URIParameter />	Adds a parameter to the URI of the createURI and CreateReturnURI tags.
<portletAPI:URIAction />	Adds a default action to the URI of the createURI and createReturnURI tags.
<portletAPI:encodeNamespace />	Maps the given string value into this portlet's namespace.
<portletAPI:init />	Provides access to the portletRequest, portletResponse, and portletConfig objects.

Deprecated tag	Replacement
<portletAPI:encodeURI/>	encodeURL() method of the ServletResponse
<portletAPI:text/>	<fmt:message/> and <fmt:bundle/> tags of the Java Standard Tag Library (JSTL). See Using JSTL in portlet JSPs for more information.