JSP Tag Reference (by Name)

This section lists all the JSP tags available for Portal development, sorted by tag name. To see a more detailed description of the tag, including tag attribute descriptions and code samples showing how to use the tag, click the tag name in Table  C-1.

Table C-1 Portal Development JSP Tags by Name  

Tag Name	Description	Tag Library
<ad:adTarget>	Send an ad query to the content management system. Unlike the <ph:placeholder> tag, the query in the <ad:adTarget> tag does not compete with other queries in an ad placeholder.	ad.tld
<catalog:getProperty>	Retrieves a property for display from either a ProductItem or Category. The property can either be an explicit property (a property that can be retrieved using a get method on the Catalog item) or an implicit property (a property available through the ConfigurableEntity getProperty methods on the Catalog item).	cat.tld
<catalog:iterateThroughView>	Iterates through a View of a specified ViewIterator. The tag will iterate the View one Catalog item at a time until the end of the View is reached.	cat.tld
<catalog:iterateViewIterator>	Iterate through a ViewIterator. A ViewIterator is an iterator over a potentially large collection of remote data that is broken up into a series of fixed sized Views.	cat.tld
<cm:getProperty>	Retrieves the value of the specified content metadata property into a variable specified by resultId. It does not have a body. If resultId is not specified, the value will be inlined into the page, similar to the <cm:printProperty> tag. .	cm.tld
<cm:printDoc>	Inlines the raw bytes of a Document object into the JSP output stream. This tag does not support a body and only supports Document objects. It does not differentiate between text and binary data.	cm.tld
<cm:printProperty>	Inlines the value of the specified content metadata property as a string. It does not have a body. This tag operates on any ConfigurableEntity, not just the Content object. However, it does not support ConfigurableEntity successors.	cm.tld
<cm:select>	Uses only the search expression query syntax to select content. It does not support or use a body. After this tag has returned the <es:forEachInArray> tag zero can be used to iterate over the array of Content objects. This tag supports generic Content via a ContentManager interface.	cm.tld
<cm:selectById>	Retrieves content using the Content's unique identifier. This tag does not have a body. This tag is basically a wrapper around the select tag. It works against any Content object which has a string-capable primary key.	cm.tld
<eb:smnav>	Retrieve value objects so that only what is viewed is retrieved. This tag allows you to control the presentation of elements in the list of value objects that are being viewed, and provides links to the previous and next pages	eb.tld
<es:convertSpecialChars>	Converts characters which would normally signify special meaning to an HTML browser into characters which can be displayed as intended.	es.tld
<es:counter>	Creates a for loop.	es.tld
<es:date>	Gets a date- and time-formatted String based on the user's time zone preference.	es.tld
<es:forEachInArray>	Iiterate over an array.	es.tld
<es:isNull>	Checks to see if a value is null. In the case of a String, the <es:isNull> tag is used to check if the String is null or has a value. An empty string will cause isNull to be false (an empty string is not null).	es.tld
<es:notNull>	The <es:notNull> tag is used to check if a value is not null. In the case of a String, the <es:notNull> tag is used to check if the String is not null or has a value. An empty string will cause notNull to be true (an empty string is treated as a value).	es.tld
<es:transposeArray>	The <es:transposeArray> tag is used to transpose a standard [row][column] array to a [column][row] array.	es.tld
<es:uriContent>	Pulls content from a URL. It is best used for grabbing text-heavy pages.	es.tld
<i18n:getMessage>	Used in conjunction with the <i18n:localize> tag to retrieve localized static text or messages from a JspMessageBundle.	i18n.tld
<i18n:localize>	Allows you to define the language, country, variant, and base bundle name to be used throughout a page when accessing resource bundles via the <i18n:getmessage> tag. .	i18n.tld
<ph:placeholder>	Implements a placeholder, which describes the behavior for a location on a JSP page. You use the E-Business Control Center to define a placeholder. See also <ad:adTarget>.	ph.tld
<portal:createPortalPageChangeURL>	Generates a webflow URL for a page change event.	portal.tld
<portal:createWebflowURL>	Dynamically creates a Webflow URL in a JSP. The Webflow URL may include the protocol, domain name, port, Web application URI, WebflowServlet URI, and query string.	portal.tld
<portal:form>	Generatse an HTML form tag. This tag is not as sophisticated as the <portal:validatedForm> tag, but is simpler. For more information about the <portal:validatedForm> tag, refer to the next section.	portal.tld
<portal:validatedForm>	Dynamically generates HTML forms that can be validated. When a Web site visitor enters invalid information, the visitor's input is preserved and redisplayed with an appropriate error message.	portal.tld
<portlet:createPortletEditURL>	Generates a webflow URL that represents editing a portlet.	portlet.tld
<portlet:createPortletFloatURL>	Generates a webflow URL that represents creating a "floating" portlet, which is a portlet that appears in an independent window.	portlet.tld
<portlet:createPortletMaximizeURL>	Generates a webflow URL that represents maximizing a portlet.	portlet.tld
<portlet:createPortletMinimizeURL>	Generates a webflow URL that represents minimizing a portlet.	portlet.tld
<portlet:createPortletUneditURL>	Generates a webflow URL that represents leaving the edit URL and moving to another page.	portlet.tld
<portlet:createPortletUnmaximizeURL>	Generates a webflow URL that represents unmaximizing a portlet.	portlet.tld
<portlet:createPortletUnminimizeURL>	Generates a webflow URL that represents unminimizing a portlet.	portlet.tld
<portlet:createWebflowURL>	Dynamically creates a Webflow URL in a JSP. The Webflow URL may include the protocol, domain name, port, Web application URI, WebflowServlet URI, and query string.	portlet.tld
<portlet:form>	Dynamically generates an HTML form tag. This tag is not as sophisticated as the <portlet:validatedForm> tag, but is simpler to use.	portlet.tld
<portlet:getException>	Retrieves the exception or message thrown by a webflow processor. This can be the message associated with a InvalidFormFieldException or ProcessingException. This tag can be inlined in which it calls getMessage() on the exception or return a scripting variable representing the exception itself.	portlet.tld
<portlet:validatedForm>	Dynamically generates HTML forms that can be validated. When a Web site visitor enters invalid information, the visitor's input is preserved and redisplayed with an appropriate error message.	portlet.tld
<ps:getPropertyNames>	Retrieves a list of property names given a property set.	ps.tld
<ps:getPropertySetNames>	Retrievest a list of property sets given a property set type.	ps.tld
<ps:getRestrictedPropertyValues>	Returns a list of restricted values for a specific property definition, converted into Strings. These values will be returned as an array of Strings.	ps.tld
<pz:contentQuery>	Performs a content attribute search for content in a content manager. If the useCache attribute is set to true, the results of a content management query will be cached. The tag only has a begin tag and does not have a body or end tag. It returns an array of Content objects returned from the content manager as the result of executing the content query.	cm.tld
<pz:contentSelector>	Allows arbitrary personalized content to be recommended based on a content selector rule.	cm.tld
<pz:div>	Allows a piece of content to be conditionally included as a result of a classifier rule being executed by the rules engine. If the user's profile matches the classification specified in the E-Business Control Center, then the conditional content is included. This tag has a begin tag, a body, and an end tag. The tag returns a list of Classification objects that the user belongs to.	cm.tld
<tr:clickContentEvent>	Generatse a behavior event when a user has clicked (through) on an ad impression. This tag will return a URL query string containing event parameters. It is then used when forming the complete URL that hyperlinks the content	tracking.tld
<tr:displayContentEvent>	Generates a behavior event when a user has received (viewed) an ad impression, (typically a gif image).	tracking.tld
<trp:clickProductEvent>	Generates a behavior event when a user has clicked (through) on a product impression. This tag will return a URL query string containing event parameters. It is then used when forming the complete URL that hyperlinks the content.	productTrack-ing.tld
<trp:displayProductEvent>	Generates a behavior event when a user has received (viewed) a product impression, (typically a gif image). At least one of sku, categoryId, or documentId is required.	productTrack- ing.tld
<um:addGroupToGroup>	Adds the group corresponding to the provided childGroupName to the group corresponding to the provided groupName. Since a group can only have one parent, any previous database records which reflect the group belonging to another parent will be destroyed. Both the parent group and the child group must previously exist for proper tag behavior. The tag has no enclosed body.	um.tld
<um:addUserToGroup>	Adds the user corresponding to the provided username to the group corresponding to the provided groupName. Both the specified user and the specified group must previously exist for proper tag behavior. The tag has no enclosed body.	um.tld
<um:createGroup>	Creates a new group in the realm, and a corresponding group profile in the personalization database. This tag has no enclosed	um.tld
<um:createUser>	Creates a new user profile. This tag has no enclosed body. Although classified as a Group-User management tag, this tag can be used in conjunction with run-time activities, in that it will persist any properties associated with a current Anonymous User Profile if specified.	um.tld
<um:getChildGroupNames>	Returns the names of any groups that are children of the given group.	um.tld
<um:getGroupNamesForUser>	Retrieves a String array that contains the group names corresponding to groups to which the provided user immediately belongs. This tag has no enclosed body.	um.tld
<um:getParentGroupName>	Retrieves the name of the parent of the group associated with the provided groupName. The information is taken from the realm. This tag has no enclosed body.	um.tld
<um:getProfile>	Retrieves the profile corresponding to the provided profile key and profile type. The tag has no enclosed body. The retrieved profile can be treated as a com.bea.p13n.usermgmt.profile.ProfileWrapper.	um.tld
<um:getProperty>	Retrieves the property value for a specified property set-property name pair. The tag has no enclosed body. The value returned is an Object.	um.tld
<um:getPropertyAsString>	Works exactly like the <um:getProperty> tag, but ensures that the retrieved property value is a String. The following example shows a multi-valued property which returns a Collection, but presents a list of favorite colors.	um.tld
<um:getTopLevelGroups>	Retrieves an array of group names, each of which has no parent group. The information is taken from the realm. This tag has no enclosed body.	um.tld
<um:getUsernames>	Retrieves a String array that contains the usernames matching the provided search expression. The search expression supports only the asterisk (*) wildcard character, and is case insensitive. As many asterisks as desired may be used in the search expression. This tag has no enclosed body.	um.tld
<um:getUsernamesForGroup>	Retrieves a String array that contains the usernames matching the provided search expression and correspond to members of the provided group. The search expression supports only the asterisk (*) wildcard character, and is case insensitive. As many asterisks as desired may be used in the search expression. This tag has no enclosed body.	um.tld
<um:login>	Provides weak authentication (username, password) against the current security realm, and sets the authenticated user as the current WebLogic user. This tag has no enclosed body.	um.tld
<um:logout>	Ends the current user's WebLogic Server session. This tag should be used in combination with the <um:login> tag.	um.tld
<um:removeGroup>	Removes the group corresponding to the provided groupName. This tag has no enclosed body.	um.tld
<um:removeGroupFromGroup>	Removes a child group from a parent group.	um.tld
<um:removeProperty>	Removes the specified property from the current session's profile or from the Anonymous User Profile. The tag has no enclosed body. Subsequent calls to <um:getProperty> for a removed property would result in the default value for the property as prescribed by the property set, or from the Profile's successor.	um.tld
<um:removeUser>	Removes the user corresponding to the provided username. It can remove any type of extended user that has its profileType set in the database. This tag has no enclosed body.	um.tld
<um:removeUserFromGroup>	Removes a user from a group. **This tag should only be invoked when the current realm is an implementation of weblogic.security.acl. ManageableRealm. This interface is implemented by the default WebLogic Portal realm (com.bea.p13n.security.realm. RDBMSRealm).	um.tld
<um:setPassword>	Updates the password for the user corresponding to the provided username.**This tag should only be invoked when the current realm is an implementation of weblogic.security.acl. ManageableRealm. .	um.tld
<um:setProperty>	Updates a property value for either the session's current profile, or for the Anonymous User Profile. This tag has no enclosed body.	um.tld
<util:invalidURL>	Processes the body if the supplied url is null or less than four characters long.	util.tld
<util:validURL>	Processes the body if the supplied url is not null and greater than three characters long.	util.tld
<webflow:checkbox>	Generates the required HTML for a check box. This tag will preserve input upon the InputProcessor throwing an InvalidFormFieldException. This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:createResourceURL>	Creates a static URL for a resource, using the value of the P13N_STATIC_ROOT context parameter in the application's WEB-INF/web.xml file. This tag may be used to load GIF images from a separate server.	webflow.tld
<webflow:createWebflowURL>	Dynamically creates a Webflow URL in a JSP. The Webflow URL may include the protocol, domain name, port, Web application URI, WebflowServlet URI, and query string.	webflow.tld
<webflow:form>	Dynamically generates an HTML form tag. This tag is not as sophisticated as the <webflow:validatedForm> tag, but is simpler.	webflow.tld
<webflow:getException>	Retrieves the exception or message thrown by a Webflow processor. This can be the message associated with an InvalidFormFieldException exception or a ProcessingException exception. This tag can be inlined (in which it calls the getMessage() method on the exception) or return a scripting variable representing the exception.	webflow.tld
<webflow:getProperty>	Retrieves a named property from the Pipeline Session. This tag can be inlined or return a scripting variable.	webflow.tld
<webflow:getValidatedValue>	Display the fields in a form that a Web site visitor must correct. The <webflow:getValidatedValue> tag is used in tandem with the<webflow:setValidatedValue> tag.	webflow.tld
<webflow:option>	Represent an HTML option, but preserves the input. An option is one value in a list box. This tag must be nested in the <webflow:select> tag.	webflow.tld
<webflow:password>	This tag is similar to the <webflow:text> tag except that field input is masked with asterisks (****). This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:radio>	Represents an HTML radio button, but preserves the input. This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:select>	Represent a list box, but preserves its input. This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:setProperty>	Sets a property in the Pipeline Session.	webflow.tld
<webflow:setValidatedValue>	Configures the display of fields in a form that a Web site visitor must correct. Usually this is done within an Input Processor, but it can also be done from a JSP by using this tag.	webflow.tld
<webflow:text>	Validates an HTML text field. This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:textarea>	Represents an HTML text area, but preserves the input. This tag must be nested in the <webflow:validatedForm> tag.	webflow.tld
<webflow:validatedForm>	Dynamically creates the URL that defines the action in an HTML form. This tag should be used in conjunction with the com.bea.p13n.appflow.webflow.forms.* package and the other nested form tags defined in the webflow.tld file.	webflow.tld
<wl:cache>	Specifies that its contents do not necessarily need to be updated every time it is displayed.	wl.tld
<wl:process>	Queries attribute-based flow control. By using a combination of the four attributes, you can selectively execute the statements between the <wl:process> and </wl:process> tags.	wl.tld
<wl:repeat>	Iterates over a variety of Java objects, as specified in the set attribute.	wl.tld