Package com.ibm.wps.engine.tags

See:
Description

Class Summary

StateSerializeTag

Provides a way to print out the current state document in XML form.

Package com.ibm.wps.engine.tags Description

Aggregation tags

Templates carry out the aggregation of the output of the portal applications as described in the Aggregation Document. These templates consist of 2 parts, the template class and the template JSP. Customization is achieved by modifying the JSP. To avoid the need for java scriptlets in the JSP templates, and to ease the job of the template programmer, WPS defines a custom tag library that provides all required functions like getting date/time, looking up portal URIs, or detecting allowed Portlet modes .

1.1 Tag Groups overview

According to the different templates for the window, screen and component, there will be tags, which will work only in the specified templates. Other tags, which are more general in nature, will work in all of these templates.

1.1.1 General Tags

These tag can be used in all templates

Tag		Description	Restrictions
Dump
Date		Get the current date
Time		Get the current time
Text		Get a string from a resource bundle
	Text Param	Set a text parameter for the string in the resource bundle	This tag can only be executed in the body of the Text tag.
Problem		Gets a string for a problem from a resource bundle
User		Get information on the current user
URL		Generate a specific Portal URL
URL Base		Generate the URL to the Portal Servlet
If Unless		Allows conditionally to execute the body of this tag
	If loggedIn= Unless loggedIn=	Check for a logged in user
	If capableOf= Unless capableOf=	Check for a device capability
	If pageSelected= Unless pageSelected=	Check for a selected page	Special meaning inside a pageLoop tag
	If problem= Unless problem=	Check for a Problem
	If screen= If notScreen= Unless screen=	Check for specific screen values
	If locale If notLocale Unless locale=	Check for specific locale values
* current Page		Get information on the current page
* currentPageGroup		Get information on the current page group
Dump		Print debug information

1.1.2 Window Tags

These Tags are used in the Window template.

Tag		Description	Restrictions
PageGroupLoop		Execute body for all page groups of the user
	PageGroup	Get information on the current page group	Can only be executed in the pageGroupLoop tag
	UrlParent	Get Url to select the current page group	Function defined by the surrounding tag
	If pageGroupSelected= Unless pageGroupSelected=	Execute body if the page group is / is not the selected one	Can only be executed in the pageGroupLoop tag
PageLoopInit		Set up the parameters for the page loop
PageLoop		Execute body for the selected pages of the current page group
	Page	Get information on the current page	Can only be executed in the pageLoop tag
	UrlParent	Get Url to select the current page	Function defined by the surrounding tag
	If pageSelected Unless pageSelected	Execute body if the page is / is not the selected one	Special meaning inside PageLoop tag
PageLoopShift		Prepare an URL to shift the window of visible pages
ScreenRender		Start the rendering of the screen
Theme		Get the name of the current theme
If pageAvailablePrevious= If pageAvailableNext= Unless pageAvailablePrevious- Unless pageAvailableNext=		Check if a page outside the defined window is available

1.1.3 ScreenTags

These tags can only be used in the screen template of the home screen

Tag	Description	Restrictions
* PageRender	Starts the rendering of a page	Can only be used in the home screen
* ControlListRender	Starts a special rendering of a page	Can only be used in the home screen
* beginPage	Include the output of the begin Page call to the portlets	Can only be used in the home screen
If pageAvailable= Unless pageAvailable=	Check if a page to render is available	Can only be used in the home screen

1.1.4 Component Tags

1.1.4.1 General Component Tags

These tags can be used in all component templates

Tag	Description	Restrictions
* CurrentPortlet	Returns information on the current Portlet (name/Id)

1.1.4.2 Container Tags

These Tags can only be executed inside a container template

Tag		Description	Restrictions
ComponentLoop		Execute body for all child components of the container
	ComponentRender	Starts the rendering of the child component	Can only be used inside the ComponentLoop Tag
	*Component	Get information on the current component (name, id, *width)	Can only be used inside the ComponentLoop Tag
	Width	Returns the HTML width attribute followed by the absolute or relative width of the current component	Can only be used inside the ComponentLoop Tag

1.1.4.3 Control Tags

These tags can only be executed inside a Control JSP

Tag			Description	Restrictions
Portlet Title			Get the title of the Portlet
PortletRender			Start the rendering of the Portlet
Component ***???
Conditionally prepare URLs
	PortletHelp		If help is supported prepare URL for Help Button
	PortletEdit		If edit is supported prepare URL for edit Button
	PortletConfigure		If configure is supported prepare URL for configure Button
	PortletMaximize		If maximized is supported prepare URL for maximize Button
	PortletMinimize		If minimize is supported prepare URL for minimize Button
	PortletRestore		If minimized or maximized is supported prepare URL for restore Button
	PortletBack		If mode not View, prepare URL for back Button
		ParentUrl	Prints the prepared URL	Can only be executed inside one of the URL preparing tags.
If portletMode= Unless portletMode=			Check the Portlet mode
If portletState= Unless portletState=			Check the Portlet state