THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Related Documents
- JavaDoc List (Documents Page)
- Control Servlet Guide
- Regions Guide
Introduction
The Open For Business JSP Tag Library consists of a set of custom tags that make it easier to use other components of the OFBiz Core Framework.
While there are some basic conditional, flow control, i18n and other general tags included in the library many of these can be found in other more generalized tag library like the Jakarta library. They are mainly included here for convenience and have defaults that are more friendly for use in the OFBiz framework.
The following table presents a list of the OFBiz tags and some basic information about them for reference. The rest of the document explains each tag in detail
| Tag Name | BodyContent | Tag Class | TEI Class |
|---|---|---|---|
| url | JSP | UrlTag | |
| contenturl | JSP | ContentUrlTag | |
| if | JSP | IfTag | |
| unless | JSP | UnlessTag | |
| iterator | JSP | IteratorTag | IteratorTEI |
| iteratorNext | JSP | IterateNextTag | IterateNextTEI |
| iteratorHasNext | JSP | IteratorHasNextTag | |
| format | JSP | FormatTag | |
| empty | PrintTag | ||
| field | empty | EntityFieldTag | |
| entityfield | empty | EntityFieldTag | |
| inputvalue | empty | InputValueTag | |
| i18nBundle | JSP | I18nBundleTag | |
| i18nMessage | JSP | I18nMessageTag | |
| i18nMessageArgument | empty | I18nMessageArgumentTag | |
| service | JSP | ServiceTag | |
| param | empty | ParamTag | |
| object | JSP | ObjectTag | ObjectTEI |
URL Tags
Add control path and URL encode if necessary. This is for links to dynamic pages in the same webapp and the body is meant to contain a forward slash ("/") and then the name of a request defined in the controller.xml file. Parameters should also be included inside the tag.
The tag will automatically insert the mounting point of the current webapp and the mounting point of the control servlet.
The tag will also create a secure (HTTPS) URL (a URL that refers to the secure port on the server) to automatically go from insecure to secure areas, and will create an plain or non-secure (HTTP) URL to automatically go from secure to insecure areas of the site. This is configured in the url.properties file. See the Core Configuration Guide for more details.
This tag has no attributes.
Builds a URL for content referred to by this page. This is generally for static content such as images that can be stored on a different server. So, if necessary it will create a complete URL for the static content and is takes into account whether the content should be referred to securely (with HTTPS) or not (with HTTP).
This is also configured in the url.properties file as described in the Core Configuration Guide.
This tag has no attributes.
Conditional Tags
ofbiz:if
Processes the body content of the tag if the named attribute value exists and if it meets any size and value conditions specified.
| Attribute Name | Required? | ExprVal? | Description |
|---|---|---|---|
| name | Y | Y | The name of the page, request, session, or application attribute to use for the comparison. |
| type | N | N | The type of the attribute Object. It is not necessary to specify this because the tag will test the type of the object at runtime. Only necessary if the default behavior does not behave as desired. |
| value | N | Y | If specified the named attribute value will be compared to this value. Can be specified using the <%=...%> syntax to refer to an existing object declared within the JSP. |
| size | N | N | If specified this value will be compared to the size of the named attribute value. This is mostly applicable for type such as Collections, Maps, Strings, etc. |
Does the exact opposite of the if tag. In other words the body content will be evaluated if the named attribute value does not exist or if it does exist but does not meet the size and value conditions.
The attributes of the unless tag are the same as the attributes of the if tag. Refer to the table above in the if tag section for detailed information on these attributes.
Flow Control Tags
The iterator tag iterates over a collection of elements in a collection object in a named attribute. The individual elements are placed in a pageContext attribute, and made available in the JSP Java context for use in scriptlets.