META-INF.ao.tld Maven / Gradle / Ivy
Show all versions of ao-taglib Show documentation
<p>
&IdAttribute_description;
</p>
id
false
true
java.lang.String
">
</a>
tag will override this value.">
<p>
&IdBufferedAttribute_description;
</p>
id
false
true
java.lang.String
">
<p>
&ClassAttribute_description;
</p>
class
false
true
java.lang.Object
">
</a>
tag will override this value.">
<p>
&ClassBufferedAttribute_description;
</p>
class
false
true
java.lang.Object
">
<p>
&DirAttribute_description;
</p>
dir
false
true
java.lang.String
">
</a>
tag will override this value.">
<p>
&DirBufferedAttribute_description;
</p>
dir
false
true
java.lang.String
">
<p>
&StyleAttribute_description;
</p>
style
false
true
java.lang.Object
">
</a>
tag will override this value.">
<p>
&StyleBufferedAttribute_description;
</p>
style
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onblur.asp">onblur</a> handler.
A nested <a href="@{project.url}&tld;/tag-onblur"></a>
tag will override this value.
</p>
onblur
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onchange.asp">onchange</a> handler.
A nested <a href="@{project.url}&tld;/tag-onchange"></a>
tag will override this value.
</p>
onchange
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onclick.asp">onclick</a> handler.
A nested <a href="@{project.url}&tld;/tag-onclick"></a>
tag will override this value.
</p>
onclick
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/jsref/event_onerror.asp">onerror</a> handler.
A nested <a href="@{project.url}&tld;/tag-onerror"></a>
tag will override this value.
</p>
onerror
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onfocus.asp">onfocus</a> handler.
A nested <a href="@{project.url}&tld;/tag-onfocus"></a>
tag will override this value.
</p>
onfocus
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onkeypress.asp">onkeypress</a> handler.
A nested <a href="@{project.url}&tld;/tag-onkeypress"></a>
tag will override this value.
</p>
onkeypress
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/jsref/event_onload.asp">onload</a> handler.
A nested <a href="@{project.url}&tld;/tag-onload"></a>
tag will override this value.
</p>
onload
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onmouseout.asp">onmouseout</a> handler.
A nested <a href="@{project.url}&tld;/tag-onmouseout"></a>
tag will override this value.
</p>
onmouseout
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onmouseover.asp">onmouseover</a> handler.
A nested <a href="@{project.url}&tld;/tag-onmouseover"></a>
tag will override this value.
</p>
onmouseover
false
true
java.lang.Object
">
<p>
A JavaScript <a href="https://www.w3schools.com/tags/ev_onsubmit.asp">onsubmit</a> handler.
A nested <a href="@{project.url}&tld;/tag-onsubmit"></a>
tag will override this value.
</p>
onsubmit
false
true
java.lang.Object
">
]>
@{description.html}
]]>&tld_description;
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:
]]>
&tld_displayName;
@{parsedVersion.majorVersion}.@{parsedVersion.minorVersion}.@{parsedVersion.incrementalVersion}
ao
&tld_uri;
Renders an <a> tag.
The body is trimmed while written.
If the body is empty after being trimmed, then href itself will be written as the body,
represented in RFC 3987: IRI Unicode format.
If the href has a scheme of mailto:
, telnet:
, or tel:
,
the scheme is stripped and the remainder of the href is displayed.
Any attribute that has no namespace and begins with param.
is added to the href as a URL parameter.
The parameter name is the part of the attribute name following param.
.
When a parameter value is null
it is not added.
If the value is an
Iterable,
Iterator,
Enumeration,
or array, then each non-null element is coerced to
String as a separate
parameter in iteration order. Otherwise, the value itself is
coerced to String
for the parameter value.
Nested <ao:param> or
<ao:params> tags will
add parameters after any provided as attributes.
]]>
a
&package;.ATag
com.aoapps.taglib.ElementTagTEI
&JSP;
&GlobalBufferedAttributes;
The href for the link.
The href is modified in several ways to make things much easier to work with.
A nested <ao:href>
tag will override this value.
In order to make relative paths predictable, relative paths are interpreted from
the current JSP page.
In order to keep paths app-relative, if starts with a /, the context path will be
prepended to the path.
In order to simplify things behind URL mapping schemes,
the href is always written starting with '/'. This avoids any need to include any
<ao:base> tags.
URL rewriting is performed as needed via
HttpServletResponse.encodeURL.
To support paths in different character sets, a Unicode to ASCII URI encoding is performed
on every character that is not defined in RFC 3986: Reserved Characters.
To avoid ambiguity, any dynamic parameters or anchors in the URL must have been correctly encoded by the caller.
Any directly nested <ao:param>
or <ao:params>
tag will add parameters to the href.
]]>
href
false
true
java.lang.String
When true
, generates an absolute URL for the href for the link.
Defaults to false
.
]]>
absolute
false
true
boolean
When true
, will generate a Canonical URL.
Canonical URLs should be used where per-user response URL rewriting
(such as information added when cookies are disabled) should be avoided.
Defaults to false
.
]]>
canonical
false
true
boolean
If the href represents a local resource, a parameter of "lastModified=#####" may be
automatically added with the timestamp of the local resource to the nearest second.
May be one of true
, false
, or auto
.
Defaults to auto
.
In auto mode, last modified stamping may be disabled by the client with
the X-com-aoapps-servlet-lastmodified-enabled: false
header.
In auto mode, last modified stamping is not performed on
Canonical URLs.
]]>
addLastModified
false
true
java.lang.String
The hreflang for the link.
A nested <ao:hreflang>
tag will override this value.
]]>
hreflang
false
true
java.lang.Object
The rel for the link.
A nested <ao:rel>
tag will override this value.
]]>
rel
false
true
java.lang.String
The target for the link.
A nested <ao:target>
tag will override this value.
]]>
target
false
true
java.lang.String
The title text for the element.
A nested <ao:title>
tag will override this value.
]]>
title
false
true
java.lang.Object
The type for the link.
A nested <ao:type>
tag will override this value.
]]>
type
false
true
java.lang.Object
&OnclickAttribute;
&OnmouseoutAttribute;
&OnmouseoverAttribute;
true
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.
]]>
action
&package;.ActionTag
&JSP;
Provides an alt attribute to its
AltAttribute
parent tag.
]]>
alt
&package;.AltTag
&JSP;
Renders an <area> tag.
The body is invoked to support nested tags, but with any output discarded.
Any attribute that has no namespace and begins with param.
is added to the href as a URL parameter.
The parameter name is the part of the attribute name following param.
.
When a parameter value is null
it is not added.
If the value is an
Iterable,
Iterator,
Enumeration,
or array, then each non-null element is coerced to
String as a separate
parameter in iteration order. Otherwise, the value itself is
coerced to String
for the parameter value.
Nested <ao:param> or
<ao:params> tags will
add parameters after any provided as attributes.
]]>
area
&package;.AreaTag
com.aoapps.taglib.AreaTagTEI
&JSP;
&GlobalBufferedAttributes;
The shape of the area.
Must be one of "default"
, "rect"
, "circle"
, or "poly"
.
]]>
shape
true
true
java.lang.String
The coordinates of the area.
Required except when shape
is "default"
.
]]>
coords
false
true
java.lang.String
The href for the area.
The href is modified in several ways to make things much easier to work with.
A nested <ao:href>
tag will override this value.
In order to make relative paths predictable, relative paths are interpreted from
the current JSP page.
In order to keep paths app-relative, if starts with a /, the context path will be
prepended to the path.
In order to simplify things behind URL mapping schemes,
the href is always written starting with '/'. This avoids any need to include any
<ao:base> tags.
URL rewriting is performed as needed via
HttpServletResponse.encodeURL.
To support paths in different character sets, a Unicode to ASCII URI encoding is performed
on every character that is not defined in RFC 3986: Reserved Characters.
To avoid ambiguity, any dynamic parameters or anchors in the URL must have been correctly encoded by the caller.
Any directly nested <ao:param>
or <ao:params>
tag will add parameters to the href.
]]>
href
false
true
java.lang.String
When true
, generates an absolute URL for the href for the area.
Defaults to false
.
]]>
absolute
false
true
boolean
When true
, will generate a Canonical URL.
Canonical URLs should be used where per-user response URL rewriting
(such as information added when cookies are disabled) should be avoided.
Defaults to false
.
]]>
canonical
false
true
boolean
If the href represents a local resource, a parameter of "lastModified=#####" may be
automatically added with the timestamp of the local resource to the nearest second.
May be one of true
, false
, or auto
.
Defaults to auto
.
In auto mode, last modified stamping may be disabled by the client with
the X-com-aoapps-servlet-lastmodified-enabled: false
header.
In auto mode, last modified stamping is not performed on
Canonical URLs.
]]>
addLastModified
false
true
java.lang.String
The hreflang for the area.
A nested <ao:hreflang>
tag will override this value.
]]>
hreflang
false
true
java.lang.Object
The rel for the area.
A nested <ao:rel>
tag will override this value.
]]>
rel
false
true
java.lang.String
The target for the area.
A nested <ao:target>
tag will override this value.
]]>
target
false
true
java.lang.String
The type for the area.
A nested <ao:type>
tag will override this value.
]]>
type
false
true
java.lang.Object
The alt text for the area.
A nested <ao:alt>
tag will override this value.
]]>
alt
false
true
java.lang.Object
The title text for the element.
A nested <ao:title>
tag will override this value.
]]>
title
false
true
java.lang.Object
&OnclickAttribute;
&OnmouseoverAttribute;
&OnmouseoutAttribute;
true
Adds an argument to its
ArgsAttribute
parent tag.
]]>
arg
&package;.ArgTag
&JSP;
The name of argument tag.
A nested <ao:name>
tag will override this value.
]]>
name
false
true
java.lang.Object
The value of the parameter.
A nested <ao:value>
tag will override this value.
If neither is provided, the output of the body is used with whitespace trimmed.
]]>
value
false
true
java.lang.Object
Evaluates the test expression, if it is not true
throws
AssertionError
with the optional message.
]]>
assert
com.aoapps.taglib.AssertTag
empty
The condition to be evaluated. This condition is always evaluated
regardless whether Java assertions are enabled or disabled.
]]>
test
true
true
boolean
The message included in the
AssertionError,
only evaluated as-needed due to use of deferred expressions.
]]>
message
false
java.lang.String
Adds a <base> tag only when necessary.
After forward (or forward fall-back from redirect), relative paths
might not resolve relative to the current JSP page. This will be most
evident when forwarding between different directories.
To keep paths relative to the page after a forward, a <base> tag is
written when the path of the current JSP page does not equal the path
of the original request.
A <base> tag will affect any anchor links on a page. For this
reason, this <base> tag primarily exists for when a redirect has to fall-back
to a forward to a resource in another path. Properly displaying the main
contents in this case is considered more important than correctly behaving anchors.
]]>
base
&package;.BaseTag
com.aoapps.taglib.ElementTagTEI
&JSP;
&GlobalBufferedAttributes;
true
Writes a <br>
tag in the current serialization.
]]>
br
&package;.BrTag
com.aoapps.taglib.ElementTagTEI
&JSP;
&GlobalBufferedAttributes;
true
Sets the bundle used by any nested
<ao:message> tags
or functions.
]]>
bundle
com.aoapps.taglib.BundleTag
JSP
The base name of resource bundle to access.
]]>
basename
true
true
java.lang.String
The prefix applied to any nested
<ao:message> tag
or function keys.
]]>
prefix
false
true
java.lang.String
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.
]]>
checked
&package;.CheckedTag
&JSP;
Like
<c:choose>,
except uses deferred expressions.
]]>
choose
com.aoapps.taglib.ChooseTag
JSP
Provides a class attribute to its
ClassAttribute
parent tag.
]]>
class
&package;.ClassTag
&JSP;
Writes a <col>
tag in the current serialization.
]]>
col
&package;.ColTag
com.aoapps.taglib.ElementTagTEI
&JSP;
&GlobalBufferedAttributes;
The span of the element.
]]>
span
false
true
int
true
Provides a content attribute to its
ContentAttribute
parent tag.
]]>
content
&package;.ContentTag
&JSP;
Provides a dir attribute to its
DirAttribute
parent tag.
]]>
dir
&package;.DirTag
&JSP;
Disables the resource editor for this request.
]]>
disableResourceEditor
com.aoapps.taglib.DisableResourceEditorTag
com.aoapps.taglib.DisableResourceEditorTagTEI
JSP
Specifies the scope over which the in-context resource editor is disabled.
Defaults to "auto".
-
When "auto" (the default), will be "body" when has tag body or "request" when there is no tag
body. This provides compatibility with previous releases that did not support body and always
disabled for the entire request.
-
When "body", the resource editor is only disabled in the tag body. The original settings, if
any, are restored.
-
When "request", the resource editor is left disabled. The original settings are not restored.
]]>
scope
false
true
java.lang.String
The mode to use when disabling the in-context resource editor.
Defaults to "disabled".
- When "disabled" (the default), the editor is completely disabled, no lookup tracking and no markup.
- When "lookup", lookup tracking is still performed, but no markup is performed.
- When "noscript", both lookup tracking and markup are performed, but without any scripts.
- When "markup", both lookup tracking and full markup are performed.
]]>
mode
false
true
java.lang.String
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.
]]>
disabled
&package;.DisabledTag
&JSP;
Provides an enctype attribute to its
EnctypeAttribute
parent tag.
]]>
enctype
&package;.EnctypeTag
&JSP;
Renders a <form> tag.
Any attribute that has no namespace and begins with param.
is added as a hidden form element.
The parameter name is the part of the attribute name following param.
.
When a parameter value is null
it is not added.
If the value is an
Iterable,
Iterator,
Enumeration,
or array, then each non-null element is coerced to
String
as a separate parameter in iteration order. Otherwise, the value itself is
coerced to String
for the parameter value.
Nested <ao:param>
or <ao:params>
tags will add parameters after any provided as attributes.
]]>
form
&package;.FormTag
com.aoapps.taglib.FormTagTEI
&JSP;
&GlobalBufferedAttributes;
The action for the form.
The action is modified in several ways to make things much easier to work with.
A nested <ao:action>
tag will override this value.
In order to make relative paths predictable, relative paths are interpreted from
the current JSP page.
In order to keep paths app-relative, if starts with a /, the context path will be
prepended to the path.
In order to simplify things behind URL mapping schemes,
the action is always written starting with '/'. This avoids any need to include any
<ao:base> tags.
URL rewriting is performed as needed via
HttpServletResponse.encodeURL.
To support paths in different character sets, a Unicode to ASCII URI encoding is performed
on every character that is not defined in RFC 3986: Reserved Characters.
To avoid ambiguity, any dynamic parameters or anchors in the URL must have been correctly encoded by the caller.
Any directly nested <ao:param>
or <ao:params>
tag will add parameters to the action.
Any URL parameters will not be in the action attribute, but instead will be rewritten into hidden form elements.
This, in conjuction with response URL rewriting, can maintain state even through posts.
]]>
action
false
true
java.lang.String
The enctype for the form.
A nested <ao:enctype>
tag will override this value.
]]>
enctype
false
true
java.lang.String
The method used, must be either post or get.
Defaults to get
.
A nested <ao:method>
tag will override this value.
]]>
method
false
true
java.lang.String
The target for the form.
A nested <ao:target>
tag will override this value.
]]>
target
false
true
java.lang.String
&OnsubmitAttribute;
true
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)