AO Taglib Reference (Legacy)

Making JSP be what it should have been all along.

This is the legacy implementation for compatibility with applications that use JSP scriptlets. When JSP scriptlets are not required, please use AO Taglib Reference.

Both implementations are interoperable and may be used simultaneously under different prefixes.

This taglib is part of an extensible suite of interoperable, context-aware, auto-encoding taglibs. All auto-encoding tags generate correct output for their context, provide context information for nested tags, and validate the output of nested tags. For example, <ao:message> within <encoding:psql> will write its output encoded as PSQL.

This suite includes, but is not limited to:

Usage

Standard Syntax

<%@ taglib prefix="ao" uri="https://oss.aoapps.com/taglib/legacy" %>

XML Syntax

<anyxmlelement xmlns:ao="https://oss.aoapps.com/taglib/legacy" />

Tag Library Information

Display Name:	AO Taglib (Legacy)
Version:	9.0.0
Short Name:	ao
URI:	https://oss.aoapps.com/taglib/legacy

Tag Summary

<ao:a>	Renders an <a> tag.
<ao:action>	Provides an action attribute to its ActionAttribute parent tag. The body of this tag, after trimming, is valid RFC 3986 URI or RFC 3987 IRI.
<ao:alt>	Provides an alt attribute to its AltAttribute parent tag.
<ao:area>	Renders an <area> tag.
<ao:arg>	Adds an argument to its ArgsAttribute parent tag.
<ao:assert>	Evaluates the test expression, if it is not `true` throws AssertionError with the optional message.
<ao:base>	Adds a <base> tag only when necessary.
<ao:br>	Writes a <br> tag in the current serialization.
<ao:bundle>	Sets the bundle used by any nested <ao:message> tags or functions.
<ao:checked>	Provides a checked attribute to its CheckedAttribute parent tag. The body, after trimming, must contain either `true`, `false`, or be empty. If empty, the checked attribute of the parent tag is not overridden.
<ao:choose>	Like <c:choose>, except uses deferred expressions.
<ao:class>	Provides a class attribute to its ClassAttribute parent tag.
<ao:col>	Writes a <col> tag in the current serialization.
<ao:content>	Provides a content attribute to its ContentAttribute parent tag.
<ao:dir>	Provides a dir attribute to its DirAttribute parent tag.
<ao:disableResourceEditor>	Disables the resource editor for this request.
<ao:disabled>	Provides a disabled attribute to its DisabledAttribute parent tag. The body, after trimming, must contain either `true`, `false`, or be empty. If empty, the disabled attribute of the parent tag is not overridden.
<ao:enctype>	Provides an enctype attribute to its EnctypeAttribute parent tag.
<ao:form>	Renders a <form> tag.
<ao:forward>	Forwards to another resource. Stops processing of the containing JSP page. This has three advantages over the standard <jsp:forward> tag: You may clear parameters such that only those specifically added will be passed on to the next page You may have other nested tags used to select and build the set of parameters You may pass argument objects instead of only String parameters (see below)
<ao:frameborder>	Provides a frameborder attribute to its FrameborderAttribute parent tag. The body, after trimming, must contain either `true`, `false`, or be empty. If empty, the frameborder attribute of the parent tag is not overridden.
<ao:getStackTraces>	Gets a detailed report of a Throwable as generated by ErrorPrinter. The content type of this tag is `text/plain`.
<ao:height>	Provides a height attribute to its HeightAttribute parent tag.
<ao:hr>	Writes a <hr> tag in the current serialization.
<ao:html>	Clears the current output buffer (leaving status code and headers) Sets the response contentType between html / xhtml based on serialization attribute and request headers Writes the <!DOCTYPE> unless set to "none" Writes the <html> tag, including the xmlns, lang, and xml:lang attributes based on the locale of the current response. Establishes a page context for AO Web Resources, if one is not already present on the current request. This is useful for using the AO Web Resources Taglib within the simplified scope of a standalone JSP page. Any page context established by this tag is cleaned-up before the tag exits - the scope is limited to nested tags.
<ao:href>	Provides an href attribute to its HrefAttribute parent tag. The body of this tag, after trimming, is valid RFC 3986 URI or RFC 3987 IRI.
<ao:hreflang>	Provides an hreflang attribute to its HreflangAttribute parent tag.
<ao:id>	Provides an id attribute to its IdAttribute parent tag.
<ao:iframe>	Renders an <iframe> tag.
<ao:img>	Renders an <img> tag.
<ao:include>	Includes another resource and then continues processing of the current JSP page. This has several advantages over the standard <jsp:include> tag: You may clear parameters such that only those specifically added will be passed on to the included page You may have other nested tags used to select and build the set of parameters You may pass argument objects instead of only String parameters (see below) You may send redirects from within the included page. You may send errors from within the included page.
<ao:input>	Renders an <input> tag.
<ao:link>	If contained within any LinksAttribute parent, adds the link data to the parent tag. Otherwise, renders a <link> tag.
<ao:map>	Renders a <map> tag.
<ao:maxlength>	Provides a maxlength attribute to its MaxlengthAttribute parent tag. The body is trimmed. If empty is sets the maxlength to `null`. Otherwise it must be a valid integer.
<ao:message>	Writes a value from the current localization bundle given its key. Writes the value with proper escaping based on the context of the tag.
<ao:messageArg>	Adds a message argument to its MessageArgsAttribute parent tag.
<ao:meta>	If contained within any MetasAttribute parent, adds the meta data to the parent tag. Otherwise, renders a <meta> tag.
<ao:method>	Provides a method attribute to its MethodAttribute parent tag.
<ao:name>	Provides a name attribute to its NameAttribute parent tag.
<ao:onblur>	Provides an onblur script to its OnblurAttribute parent tag.
<ao:onchange>	Provides an onchange script to its OnchangeAttribute parent tag.
<ao:onclick>	Provides an onclick script to its OnclickAttribute parent tag.
<ao:onerror>	Provides an onerror script to its OnerrorAttribute parent tag.
<ao:onfocus>	Provides an onfocus script to its OnfocusAttribute parent tag.
<ao:onkeypress>	Provides an onkeypress script to its OnkeypressAttribute parent tag.
<ao:onload>	Provides an onload script to its OnloadAttribute parent tag.
<ao:onmouseout>	Provides an onmouseout script to its OnmouseoutAttribute parent tag.
<ao:onmouseover>	Provides an onmouseover script to its OnmouseoverAttribute parent tag.
<ao:onsubmit>	Provides an onsubmit script to its OnsubmitAttribute parent tag.
<ao:option>	Renders an <option> tag.
<ao:otherwise>	Like <c:otherwise>, except uses deferred expressions.
<ao:out>	Writes the value with proper escaping based on the context of the tag. Supports data types beyond <c:out>.
<ao:page>	Provides a page to its PageAttribute parent tag.
<ao:param>	Adds a parameter to its ParamsAttribute parent tag.
<ao:params>	Adds multiple parameters to its ParamsAttribute parent tag.
<ao:readonly>	Provides a readonly attribute to its ReadonlyAttribute parent tag.
<ao:redirect>	Redirects the browser to another location. Stops processing of the containing JSP page. Does not send redirect when the response has already been committed, but also does not throw any exception; logs FINE-level notice instead. Important: Redirects inside of standard <jsp:include> tags will be silently lost. Use <ao:include> instead of <jsp:include> to support redirects inside of includes.
<ao:rel>	Provides a rel attribute to its RelAttribute parent tag.
<ao:resourceEditor>	Allows editing of the website resource bundles through the website itself.
<ao:script>	Manually establishes a script context when automatic detection is not possible. The body of this tag contains a script.
<ao:select>	Renders a <select> tag.
<ao:selected>	Provides a selected attribute to its SelectedAttribute parent tag.
<ao:sendError>	Returns an error status. Stops processing of the containing JSP page. Results in error handler processing. Does not send error when the response has already been committed, but also does not throw any exception; logs FINE-level notice instead. Important: Errors sent inside of standard <jsp:include> tags will be silently lost. Use <ao:include> instead of <jsp:include> to support sendError inside of includes.
<ao:size>	Provides a size attribute to its SizeAttribute parent tag.
<ao:src>	Provides a src attribute to its SrcAttribute parent tag. The body of this tag, after trimming, is valid RFC 3986 URI or RFC 3987 IRI.
<ao:style>	Provides a style attribute to its StyleAttribute parent tag, if present, otherwise manually establishes a style context. The body of this tag contains a CSS.
<ao:tabindex>	Provides a tabindex attribute to its TabindexAttribute parent tag.
<ao:target>	Provides a target attribute to its TargetAttribute parent tag.
<ao:textarea>	Renders a <textarea> tag.
<ao:title>	Provides a title attribute to its TitleAttribute parent tag.
<ao:type>	Provides a type attribute to its TypeAttribute parent tag.
<ao:url>	Manually establishes a URL context when automatic detection is not possible. The body of this tag, after trimming, is valid RFC 3986 URI or RFC 3987 IRI. The URL is modified in several ways to make things much easier to work with.
<ao:value>	Provides a value attribute to its ValueAttribute parent tag.
<ao:when>	Like <c:when>, except uses deferred expressions.
<ao:width>	Provides a width attribute to its WidthAttribute parent tag.
<ao:wordWrap>	Word wraps the textual content.
<ao:write>	Writes the bean contents. Supports data types beyond <c:out> and <bean:write>, such as XML nodes for HTML snippets.

Function Summary

long	${ao:getLastModified(String)}	Gets the lastModified timestamp in milliseconds since Epoch or `0` when not known.
String	${ao:addLastModified(String)}	If the URL represents a local resource, a parameter of "lastModified=#####" will be automatically added with the timestamp of the local resource to the nearest second.
String	${ao:encodeURIComponent(String)}	Encodes a value for use in a URI path component, query string, or fragment.
String	${ao:decodeURIComponent(String)}	Decodes a value from use as a URI path component, query string, or fragment.
String	${ao:encodeURI(String)}	Encodes a URI to ASCII format.
String	${ao:decodeURI(String)}	Decodes a URI to Unicode format.
String	${ao:encodeURL(String)}	Rewrites a URL to maintain session state or otherwise alter the URL mapping.
String	${ao:getAbsolutePath(String)}	Resolves a possibly page-relative path to a context-absolute path. `path`: The absolute URL, context-absolute path, or page-relative path.
String	${ao:getAbsoluteURL(String)}	Gets an absolute URL for the given path. This includes protocol, port, context path, and path. `path`: The path appended to the URL verbatim. To support page-relative paths, first use ${ao:getAbsolutePath()}. No URL rewriting is performed. Please additionally use ${ao:encodeURL()}, as-needed.
String	${ao:getDecimalTimeLength(Long)}	Gets a time span display for a given number of milliseconds or `null` for `null` milliseconds.
String	${ao:getProjectVersion(String, String, String, String)}	Gets the version of a Maven project given its groupId and artifactId.
boolean	${ao:isForwarded()}	Determines if the current request has been forwarded by a <ao:forward> or <ao:redirect> tag.
boolean	${ao:isRtl()}	Determines if the response locale is a right-to-left language.
String	${ao:join(Iterable<?>, String)}	Joins elements of any Iterable into a String.
String	${ao:message(String)}	Gets a value from the current localization bundle given its key. No parameters may be provided. Must be nested inside a <ao:bundle> tag.
String	${ao:wordWrap(String, int)}	Word wraps a String.
double	${ao:ceil(double)}	Calls java.lang.Math.ceil(double).
double	${ao:floor(double)}	Calls java.lang.Math.floor(double).
long	${ao:round(double)}	Calls java.lang.Math.round(double).
boolean	${ao:resourceExists(String)}	Checks if a resource exists in the web application.