All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.ao.tld Maven / Gradle / Ivy

The newest version!
















      
        <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".

  1. 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.
  2. When "body", the resource editor is only disabled in the tag body. The original settings, if any, are restored.
  3. 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".

  1. When "disabled" (the default), the editor is completely disabled, no lookup tracking and no markup.
  2. When "lookup", lookup tracking is still performed, but no markup is performed.
  3. When "noscript", both lookup tracking and markup are performed, but without any scripts.
  4. 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:

  1. You may clear parameters such that only those specifically added will be passed on to the next page
  2. You may have other nested tags used to select and build the set of parameters
  3. You may pass argument objects instead of only String parameters (see below)

Does not forward when the response has already been committed, but also does not throw any exception; logs FINE-level notice instead.

Any attribute that has no namespace and begins with param. is added to the parameters. 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. If parameters are not cleared, nested parameters are added before request parameters.

Argument objects are passed to the forwarded page via request-scope arg Map. Any arguments to the current JSP page are not automatically passed-on to the forwarded page (this differs from parameters in this way).

Any attribute that has no namespace and begins with arg. is added as an argument. The argument name is the part of the attribute name following arg.. Because this argument becomes an element in the Map named arg in the forwarded page, the attribute name and JSP Expression Language name will match precisely.

Nested <ao:arg> tags may also be used to pass arguments.

It is an error for the same argument name to be used twice (including when set as null).

]]> forward com.aoapps.taglib.ForwardTag scriptless The page that will be forwarded to. A nested <ao:page> tag will override this value. The page is required, must be set in attribute or nested <ao:page> tag.

Security Note: page must be a trusted value since it can access any resource available via RequestDispatcher. It would be incorrect to use a value that can be manipulated by a client in any way.

Recommend use of <ao:base> on target page to have relative paths interpreted from the forwarded-to page.

]]>
page false true java.lang.String
Optionally clears all parameters that match any of the comma-separated patterns. This is so that only those added by nested tags are forwarded. As a result, parameters provided by the client will not be able to interfere with forwards that have optional parameters. Each pattern in the comma-separated list may be in the following format:

exact_name matches the name exactly
* matches all (clears all parameters)
*suffix matches the name with "endsWith"
prefix* matches the name with "beginsWith"

Defaults to none cleared.

]]>
clearParams false true java.lang.String
true 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.

]]>
frameborder &package;.FrameborderTag &JSP;
Gets a detailed report of a Throwable as generated by ErrorPrinter.

The content type of this tag is text/plain.

]]>
getStackTraces com.aoapps.taglib.GetStackTracesTag com.aoapps.taglib.GetStackTracesTagTEI empty Specifies the variable scope searched to retrieve the bean specified by name. If not specified, the default rules applied by JspContext.findAttribute() are applied.

]]>
scope false true java.lang.String
Specifies the attribute name of the bean whose property is accessed to retrieve the value specified by property (if specified). If property is not specified, the value of this bean itself will be used.

]]>
name true true java.lang.Object
Specifies the name of the property to be accessed on the bean specified by name. This value may be a simple, indexed, or nested property reference expression. If not specified, the bean identified by name will itself be used.

]]>
property false true java.lang.String
Provides a height attribute to its HeightAttribute parent tag.

]]>
height &package;.HeightTag &JSP;
Writes a <hr> tag in the current serialization.

]]>
hr &package;.HrTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; true
  • 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.
  • ]]>
    html &package;.HtmlTag com.aoapps.taglib.HtmlTagTEI &JSP; &GlobalAttributes; When SGML, forces the content-type to be text/html. When XML, forces the content-type to be application/xhtml+xml. When auto (the default), the following steps are performed to resolve the serialization:

    1. Use the serialization active on the current request.
    2. Use the application context-param com.aoapps.encoding.Serialization.default that allows an application to control the selection of HTML versus XHTML.
    3. When this context-param is unspecified or auto, determine the serialization based on the client's Accept header.

    This should normally be left with the default value of auto. This is used when the content is known to contain invalid markup that can not be parsed as XML.

    ]]>
    serialization false true java.lang.String
    The <!DOCTYPE> to use, must be one of default, HTML5, STRICT, TRANSITIONAL, FRAMESET, or NONE. Defaults to default. NONE will suppress the output of a doctype.

    When default (the default), the following steps are performed to resolve the doctype:

    1. Use the doctype active on the current request.
    2. Use the application context-param com.aoapps.encoding.Doctype.default that allows an application to control the default doctype.
    3. When this context-param is unspecified or default, defaults to HTML5, which results in a breaking change (this tag used to default to STRICT).
    ]]>
    doctype false true java.lang.String
    When true, enables automatic newline (and tab indentation when enabled). When false, disables automatic newline and tab indentation. When auto (the default), the following steps are performed to resolve the autonli setting:

    1. Use the autonli setting active on the current request.
    2. Use the application context-param com.aoapps.html.servlet.DocumentEE.autonli that allows an application to control the default autonli setting.
    3. When this context-param is unspecified or auto, defaults to false.
    ]]>
    autonli false true java.lang.String
    When true, enables tab indentation. When false, disables tab indentation. When auto (the default), the following steps are performed to resolve the indent setting:

    1. Use the indent setting active on the current request.
    2. Use the application context-param com.aoapps.html.servlet.DocumentEE.indent that allows an application to control the default indent setting.
    3. When this context-param is unspecified or auto, defaults to false.
    ]]>
    indent false true java.lang.String
    true
    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.

    ]]>
    href &package;.HrefTag &JSP;
    Provides an hreflang attribute to its HreflangAttribute parent tag.

    ]]>
    hreflang &package;.HreflangTag &JSP;
    Provides an id attribute to its IdAttribute parent tag.

    ]]>
    id &package;.IdTag &JSP;
    Renders an <iframe> tag.

    Any attribute that has no namespace and begins with param. is added to the src 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.

    ]]>
    iframe &package;.IframeTag com.aoapps.taglib.ElementTagTEI &JSP; <p> &IdBufferedAttribute_description; </p> For maximum HTML/XHTML and HTML 4/5 compatibility, this value is written as both id and name attributes.

    ]]>
    id false true java.lang.String
    &ClassBufferedAttribute; &DirBufferedAttribute; &StyleBufferedAttribute; The src for the frame content. The src is modified in several ways to make things much easier to work with.

    A nested <ao:src> 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 src 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 src.

    ]]>
    src false true java.lang.String
    When true, generates an absolute URL for the src for the frame. 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 src 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 width for the frame. A nested <ao:width> tag will override this value.

    ]]>
    width false true java.lang.Integer
    The height for the frame. A nested <ao:height> tag will override this value.

    ]]>
    height false true java.lang.Integer
    The frameborder attribute. Accepts values of true or false. A non-empty nested <ao:frameborder> tag will override this value. Defaults to true.

    ]]>
    frameborder false true boolean
    true
    Renders an <img> tag.

    The src may be provided in one of three ways, in precedence order:

    1. Direct child <ao:src> tag.
    2. As the src attribute
    3. The body of this tag, after trimming, is valid RFC 3986 URI or RFC 3987 IRI.

    Also, when usemap is not set, the alt value is required either as an attribute or a nested <ao:alt> tag.

    Any attribute that has no namespace and begins with param. is added to the src 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.

    ]]>
    img &package;.ImgTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; The src for the image. The src is modified in several ways to make things much easier to work with.

    A nested <ao:src> 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 src 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 src.

    ]]>
    src false true java.lang.String
    When true, generates an absolute URL for the src for the image. 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 src 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 optional width for the image. A nested <ao:width> tag will override this value.

    ]]>
    width false true java.lang.Integer
    The optional height for the image. A nested <ao:height> tag will override this value.

    ]]>
    height false true java.lang.Integer
    The alt text for the image. 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
    Specifies an image as a client-side image-map.

    The # prefix is optional. If not provided, the # will be automatically added.

    This is expected to be used along with a <ao:map> tag.

    ]]>
    usemap false true java.lang.String
    Specifies an image as a server-side image-map.

    ]]>
    ismap false true boolean
    &OnerrorAttribute; &OnloadAttribute; true

    Includes another resource and then continues processing of the current JSP page. This has three advantages over the standard <jsp:include> tag:

    1. You may clear parameters such that only those specifically added will be passed on to the included page
    2. You may have other nested tags used to select and build the set of parameters
    3. You may pass argument objects instead of only String parameters (see below)

    Any attribute that has no namespace and begins with param. is added to the parameters. 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. If parameters are not cleared, nested parameters are added before request parameters.

    Argument objects are passed to the included page via request-scope arg Map. Any arguments to the current JSP page are not automatically passed-on to the included page (this differs from parameters in this way). The current JSP page arguments are restored when the include completes.

    Any attribute that has no namespace and begins with arg. is added as an argument. The argument name is the part of the attribute name following arg.. Because this argument becomes an element in the Map named arg in the included page, the attribute name and JSP Expression Language name will match precisely.

    Nested <ao:arg> tags may also be used to pass arguments.

    It is an error for the same argument name to be used twice (including when set as null).

    ]]>
    include com.aoapps.taglib.IncludeTag scriptless The page that will be included. A nested <ao:page> tag will override this value. The page is required, must be set in attribute or nested <ao:page> tag.

    Security Note: page must be a trusted value since it can access any resource available via RequestDispatcher. It would be incorrect to use a value that can be manipulated by a client in any way.

    ]]>
    page false true java.lang.String
    Optionally clears all parameters that match any of the comma-separated patterns. This is so that only those added by nested tags are included. As a result, parameters provided by the client will not be able to interfere with includes that have optional parameters. Each pattern in the comma-separated list may be in the following format:

    exact_name matches the name exactly
    * matches all (clears all parameters)
    *suffix matches the name with "endsWith"
    prefix* matches the name with "beginsWith"

    Defaults to none cleared.

    ]]>
    clearParams false true java.lang.String
    true
    Renders an <input> tag.

    The value may be provided in one of three ways, in precedence order:

    1. Direct child <ao:value> tag.
    2. As the value attribute
    3. Contents of tag body, trimmed.

    For type="image", the src may be provided in one of two ways, in precedence order:

    1. Direct child <ao:src> tag.
    2. As the src attribute

    Any attribute that has no namespace and begins with param. is added to the src 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.

    ]]>
    input &package;.InputTag com.aoapps.taglib.InputTagTEI &JSP; &GlobalBufferedAttributes; The alt text for the input (only for type="image"). Required when type is "image". A nested <ao:alt> tag will override this value.

    ]]>
    alt false true java.lang.Object
    Turns on or off the autocomplete for this input element. Accepts values of true or false (not "on" or "off" due to this being a boolean type). If autocomplete is false, will add the attribute as autocomplete="off", otherwise the attribute is not added. Defaults to true with no attribute added.

    ]]>
    autocomplete false true boolean
    The checked attribute. Accepts values of true or false. A non-empty nested <ao:checked> tag will override this value. If checked is true, will add the attribute as checked="checked", otherwise the attribute is not added.

    ]]>
    checked false true boolean
    The disabled attribute. Accepts values of true or false. A non-empty nested <ao:disabled> tag will override this value. If disabled is true, will add the attribute as disabled="disabled", otherwise the attribute is not added.

    ]]>
    disabled false true boolean
    The optional height for the image, (only for type="image"). A nested <ao:height> tag will override this value.

    ]]>
    height false true java.lang.Integer
    The maxlength of the input element. A nested <ao:maxlength> tag will override this value.

    ]]>
    maxlength false true java.lang.Integer
    The name of the input element. A nested <ao:name> tag will override this value.

    ]]>
    name false true java.lang.Object
    The readonly attribute. Accepts values of true or false. A non-empty nested <ao:readonly> tag will override this value. If readonly is true, will add the attribute as readonly="readonly", otherwise the attribute is not added.

    ]]>
    readonly false true boolean
    The size of the input element. A nested <ao:size> tag will override this value.

    ]]>
    size false true java.lang.Integer
    The src for the image (only for type="image"). The src is modified in several ways to make things much easier to work with.

    A nested <ao:src> 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 src 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 src.

    ]]>
    src false true java.lang.String
    When true, generates an absolute URL for the src for the image, (only for type="image"). 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 src 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 optional tabindex value. Defaults to 0. If value is >= 1, will add tabindex attribute. A non-empty nested <ao:tabindex> tag will override this value.

    ]]>
    tabindex false true int
    The title text for the element. A nested <ao:title> tag will override this value.

    ]]>
    title false true java.lang.Object
    The type of input element. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    The optional width for the image, (only for type="image"). A nested <ao:width> tag will override this value.

    ]]>
    width false true java.lang.Integer
    The value of the input element. 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
    &OnblurAttribute; &OnchangeAttribute; &OnclickAttribute; &OnerrorAttribute; &OnfocusAttribute; &OnkeypressAttribute; &OnloadAttribute; true
    If contained within any LinksAttribute parent, adds the link data to the parent tag. Otherwise, renders a <link> tag.

    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.

    ]]>
    link &package;.LinkTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; An optional link to copy all the attributes from, as captured by a LinksAttribute parent tag.

    ]]>
    link false true com.aoapps.taglib.Link
    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 type for the link. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    The media type for the link.

    ]]>
    media false true java.lang.Object
    The title for the link. A nested <ao:title> tag will override this value.

    ]]>
    title false true java.lang.Object
    &OnerrorAttribute; &OnloadAttribute; true
    Renders a <map> tag.

    This is expected to be used along with nested <ao:area> tags.

    ]]>
    map &package;.MapTag com.aoapps.taglib.ElementTagTEI &JSP; The required id (and name) of the map. Must be provided as either this attribute or a nested <ao:id> tag. A nested <ao:id> tag will override this value.

    For maximum HTML/XHTML and HTML 4/5 compatibility, this value is written as both id and name attributes.

    The id of this map should be used as the usemap attribute of an <ao:img> tag.

    ]]>
    id false true java.lang.String
    &ClassBufferedAttribute; &DirBufferedAttribute; &StyleBufferedAttribute; true
    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.

    ]]>
    maxlength &package;.MaxlengthTag &JSP;
    Writes a value from the current localization bundle given its key. Writes the value with proper escaping based on the context of the tag.

    Any number of "arg###" attributes may be provided, where ### is the substitution parameter index, starting at zero. For example, there could be arg0="First" arg1="Second" for two arguments. They will be passed-on to the message format.

    Additionally, message substitution arguments may be provided by nested <ao:messageArg> tags.

    These additional arguments will first fill-in any gap in the numeric ranges provided by "arg###" attributes. Because the first argument is zero, if arg1="Second" arg2="Third", then the first nested <ao:messageArg> would be applied filling the spot of arg0.

    Once all gaps are filled, these additional arguments will be added after all provided as "arg###" attritutes.

    This tag must be nested inside a <ao:bundle> tag.

    The content type depends on the value provided to the type attribute, and defaults to text/plain. The content is checked for well-formedness based on its type:

    • css or text/css - must be well-formed CSS content. (Note: Currently only checks character values.)
    • javascript, application/javascript, or text/javascript - no validation
    • json or application/json - no validation
    • ld_json or application/ld+json - no validation
    • text or text/plain - no validation
    • url or text/url - must be a valid URL
    • xhtml or application/xhtml+xml - must be well-formed XHTML content. (Note: Currently only checks character values.)
    • xhtml_attribute or application/xhtml+xml+attribute - must be a valid XHTML attribute.
    • mysql or text/x+mysql - must be valid MySQL command "mysql" input
    • psql or text/x+psql - must be valid PostgreSQL command "psql" input
    • sh or text/x+sh - must be valid shell script
    ]]>
    message &package;.MessageTag com.aoapps.taglib.MessageTagTEI &JSP; The base name of resource bundle to access. When not provided, uses the currently active <ao:bundle>.

    ]]>
    bundle false true java.lang.String
    The key to lookup in the bundle. This key is appended to any prefix specified in the bundle.

    ]]>
    key true true java.lang.String
    The argument that will replace {0} in the message format.

    Any number of arguments may be provided as attributes. The first four are added to TLD to help JSP code assist.

    ]]>
    arg0 false true java.lang.Object
    The argument that will replace {1} in the message format.

    Any number of arguments may be provided as attributes. The first four are added to TLD to help JSP code assist.

    ]]>
    arg1 false true java.lang.Object
    The argument that will replace {2} in the message format.

    Any number of arguments may be provided as attributes. The first four are added to TLD to help JSP code assist.

    ]]>
    arg2 false true java.lang.Object
    The argument that will replace {3} in the message format.

    Any number of arguments may be provided as attributes. The first four are added to TLD to help JSP code assist.

    ]]>
    arg3 false true java.lang.Object
    Specifies the type of content contained in the value. Defaults to text/plain. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    true
    Adds a message argument to its MessageArgsAttribute parent tag.

    ]]>
    messageArg &package;.MessageArgTag &JSP; 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
    If contained within any MetasAttribute parent, adds the meta data to the parent tag. Otherwise, renders a <meta> tag.

    The content may be provided in one of three ways, in precedence order:

    1. Direct child <ao:content> tag.
    2. As the content attribute
    3. Contents of tag body, trimmed.
    ]]>
    meta &package;.MetaTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; An optional meta to copy all the attributes from, as captured by a MetasAttribute parent tag.

    ]]>
    meta false true com.aoapps.taglib.Meta
    The name of the meta element. A nested <ao:name> tag will override this value.

    ]]>
    name false true java.lang.Object
    The http-equiv of the meta element.

    ]]>
    httpEquiv false true java.lang.String
    The itemprop used for semantic microdata.

    ]]>
    itemprop false true java.lang.String
    The charset of the meta element. Supports java.nio.charset.Charset. Any other object is coerced to string.

    ]]>
    charset false true java.lang.Object
    The content of the meta data. A nested <ao:content> tag will override this value. If neither is provided, the output of the body is used with whitespace trimmed.

    ]]>
    content false true java.lang.Object
    true
    Provides a method attribute to its MethodAttribute parent tag.

    ]]>
    method &package;.MethodTag &JSP;
    Provides a name attribute to its NameAttribute parent tag.

    ]]>
    name &package;.NameTag &JSP;
    Provides an onblur script to its OnblurAttribute parent tag.

    ]]>
    onblur &package;.OnblurTag &JSP;
    Provides an onchange script to its OnchangeAttribute parent tag.

    ]]>
    onchange &package;.OnchangeTag &JSP;
    Provides an onclick script to its OnclickAttribute parent tag.

    ]]>
    onclick &package;.OnclickTag &JSP;
    Provides an onerror script to its OnerrorAttribute parent tag.

    ]]>
    onerror &package;.OnerrorTag &JSP;
    Provides an onfocus script to its OnfocusAttribute parent tag.

    ]]>
    onfocus &package;.OnfocusTag &JSP;
    Provides an onkeypress script to its OnkeypressAttribute parent tag.

    ]]>
    onkeypress &package;.OnkeypressTag &JSP;
    Provides an onload script to its OnloadAttribute parent tag.

    ]]>
    onload &package;.OnloadTag &JSP;
    Provides an onmouseout script to its OnmouseoutAttribute parent tag.

    ]]>
    onmouseout &package;.OnmouseoutTag &JSP;
    Provides an onmouseover script to its OnmouseoverAttribute parent tag.

    ]]>
    onmouseover &package;.OnmouseoverTag &JSP;
    Provides an onsubmit script to its OnsubmitAttribute parent tag.

    ]]>
    onsubmit &package;.OnsubmitTag &JSP;
    Renders an <option> tag.

    ]]>
    option &package;.OptionTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; The disabled attribute. Accepts values of true or false. A non-empty nested <ao:disabled> tag will override this value. If disabled is true, will add the attribute as disabled="disabled", otherwise the attribute is not added.

    ]]>
    disabled false true boolean
    The selected attribute. Accepts values of true or false. A non-empty nested <ao:selected> tag will override this value. If selected is true, will add the attribute as selected="selected", otherwise the attribute is not added.

    ]]>
    selected false true boolean
    The value of the option. 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
    true
    Like <c:otherwise>, except uses deferred expressions.

    ]]>
    otherwise com.aoapps.taglib.OtherwiseTag JSP
    Writes the value with proper escaping based on the context of the tag. Supports data types beyond <c:out>.

    In addition to the usual set of coercions expected for <c:out>, also supports writing XML nodes such as for HTML snippets.

    The content type depends on the value provided to the type attribute, and defaults to text/plain. The content is checked for well-formedness based on its type:

    • css or text/css - must be well-formed CSS content. (Note: Currently only checks character values.)
    • javascript, application/javascript, or text/javascript - no validation
    • json or application/json - no validation
    • ld_json or application/ld+json - no validation
    • text or text/plain - no validation
    • url or text/url - must be a valid URL
    • xhtml or application/xhtml+xml - must be well-formed XHTML content. (Note: Currently only checks character values.)
    • xhtml_attribute or application/xhtml+xml+attribute - must be a valid XHTML attribute.
    • mysql or text/x+mysql - must be valid MySQL command "mysql" input
    • psql or text/x+psql - must be valid PostgreSQL command "psql" input
    • sh or text/x+sh - must be valid shell script

    This is compatible with <encoding:out>, with the addition of allowing nested <ao:value> and <ao:type> tags.

    ]]>
    out &package;.OutTag com.aoapps.encoding.taglib.OutTagTEI &JSP; The value to be written. A nested <ao:value> tag will override this value.

    ]]>
    value false true java.lang.Object
    The default value if the resulting value is null.

    ]]>
    default false java.lang.Object
    Specifies the type of content contained in the value. Defaults to text/plain. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    Provides a page to its PageAttribute parent tag.

    ]]>
    page &package;.PageTag &JSP;
    Adds a parameter to its ParamsAttribute parent tag.

    ]]>
    param &package;.ParamTag &JSP; The name of parameter 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
    Adds multiple parameters to its ParamsAttribute parent tag.

    ]]>
    params &package;.ParamsTag &JSP; The name of parameter to add. A nested <ao:name> tag will override this value.

    When provided, the values may not contain a Map or URIParameters. When provided, the exclude attribute may not be provided.

    ]]>
    name false true java.lang.Object
    Optionally excludes all elements of a Map or URIParameters that match any of the comma-separated patterns. May not be used in conjunction with the name attribute.

    Each pattern in the comma-separated list may be in the following format:

    exact_name matches the name exactly
    * matches all (clears all parameters)
    *suffix matches the name with "endsWith"
    prefix* matches the name with "beginsWith"

    Defaults to none excluded.

    ]]>
    exclude false true java.lang.String
    The values of the parameters.

    When name is provided, supports Iterable, Iterator, Enumeration, or array values.

    When name is not provided, requires Map or URIParameters, where the parameter name is the map key coerced to String and the value (or set of values) is the map value. Each of the entry values may be Iterable, Iterator, Enumeration, array, or single value.

    When obtaining values from a Map or URIParameters, parameters may be excluded with the "exclude" attribute.

    Parameters are never added with null values.

    ]]>
    values true true java.lang.Object
    Provides a readonly attribute to its ReadonlyAttribute parent tag.

    The body, after trimming, must contain either true, false, or be empty. If empty, the readonly attribute of the parent tag is not overridden.

    ]]>
    readonly &package;.ReadonlyTag &JSP;

    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.

    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.

    Due to browser and server URL length limitations for GET requests, it is recommended to not exceed about 2000 characters for URLs, including all parameters. See WWW FAQs: What is the maximum length of a URL?

    When redirecting to a resource within the application, such as for a 303 redirect-after-post response, it is recommended to provide the "page" attribute to allow automatic fallback to forward instead of redirect. With this redirect/forward combination, users will have the benefits of redirect-after-post while the system gracefully falls back to request forwarding when the GET request length limit is exceeded.

    ]]>
    redirect com.aoapps.taglib.RedirectTag com.aoapps.taglib.RedirectTagTEI scriptless The status code of redirect performed. Is one of:

    • moved_permanently or 301
    • moved_temporarily or 302
    • see_other or 303 - Hint: Used for redirect-after-post

    Because the redirect type has important consequences on search engines and browser caches, the decision should be made for each redirect. Thus, this attribute is required.

    ]]>
    statusCode true true java.lang.String
    The destination for the redirect. This should only be provided when either redirecting to an external resource or when the default obtained from "page" is inappropriate. The href is modified in several ways to make things much easier to work with.

    A nested <ao:href> tag will override this value.

    When not provided as attribute or a nested tag, defaults to the value for "page". This should be a reasonable default except for unusual circumstances.

    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 Location of the redirect. Defaults to true for compatibility with the requirements prior to RFC 7231: 7.1.2. Location.

    ]]>
    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 page that will be forwarded to when the GET request URL length is exceeded. It is recommended to provide the page for any redirect within a web application, such as 303 redirect-after-post. A nested <ao:page> tag will override this value.

    When forward is performed instead of redirect, the original request parameters are hidden. Only the parameters provided in the redirect are passed-on to the target page. Also, any arguments to the current JSP page are not passed-on (see <ao:include>).

    Security Note: page must be a trusted value since it can access any resource available via RequestDispatcher. It would be incorrect to use a value that can be manipulated by a client in any way.

    Recommend use of <ao:base> on target page to have relative paths interpreted from the forwarded-to page.

    When the redirect type is 302 or 303, the cache-control: no-cache header is set on the response to try to best emulate the caching effects the corresponding redirect.

    ]]>
    page false true java.lang.String
    true
    Provides a rel attribute to its RelAttribute parent tag.

    ]]>
    rel &package;.RelTag &JSP;
    Allows editing of the website resource bundles through the website itself.

    ]]>
    resourceEditor com.aoapps.taglib.ResourceEditorTag empty
    Manually establishes a script context when automatic detection is not possible. The body of this tag contains a script.

    The script should not be encoded as if in HTML/XML, it must have single "&" instead of "&amp;". The script may contain any characters valid in that language, including <, >, &, \u0000 (null), or any other values.

    The script will be properly encoded for the content of this tag. Thus, you may have a script of arbitrary complexity containing arbitrary data within an XHTML onclick attribute, the tags will make sure everything is properly encoded.

    The content type of this tag is equal to the type set in the type attribute.

    Any attribute that has no namespace and begins with param. is added to the src 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.

    For simpler scenarios, the following tags are simplier alternatives:

    ]]>
    script &package;.ScriptTag com.aoapps.taglib.ScriptTagTEI &JSP; &GlobalBufferedAttributes; Specifies the type of script. The default is application/javascript, also allows text/javascript application/json and application/ld+json. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    The src for the script. The src is modified in several ways to make things much easier to work with.

    A nested <ao:src> 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 src 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 src.

    ]]>
    src false true java.lang.String
    When true, generates an absolute URL for the src for the script. 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 src 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
    When true, loads the script asynchronously. Defaults to false.

    ]]>
    async false true boolean
    When true, loads the script deferred. Defaults to false.

    ]]>
    defer false true boolean
    &OnerrorAttribute; &OnloadAttribute; true
    Renders a <select> tag.

    ]]>
    select &package;.SelectTag com.aoapps.taglib.ElementTagTEI &JSP; &GlobalBufferedAttributes; The disabled attribute. Accepts values of true or false. A non-empty nested <ao:disabled> tag will override this value. If disabled is true, will add the attribute as disabled="disabled", otherwise the attribute is not added.

    ]]>
    disabled false true boolean
    The name of the select element. A nested <ao:name> tag will override this value.

    ]]>
    name false true java.lang.Object
    The size of the select element. A nested <ao:size> tag will override this value.

    ]]>
    size false true java.lang.Integer
    &OnblurAttribute; &OnchangeAttribute; &OnfocusAttribute; &OnkeypressAttribute; true
    Provides a selected attribute to its SelectedAttribute parent tag.

    The body, after trimming, must contain either true, false, or be empty. If empty, the selected attribute of the parent tag is not overridden.

    ]]>
    selected &package;.SelectedTag &JSP;
    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.

    ]]>
    sendError &package;.SendErrorTag &JSP; The status code for response.sendError.

    ]]>
    status true true int
    The optional message to be sent. If not set as an attribute, the message will be taken from the body, trimmed.

    ]]>
    message false true java.lang.String
    Provides a size attribute to its SizeAttribute parent tag.

    ]]>
    size &package;.SizeTag &JSP;
    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.

    ]]>
    src &package;.SrcTag &JSP;
    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.

    ]]>
    style &package;.StyleTag &JSP; Forces the creation of a manual style context even when within a StyleAttribute parent tag.

    At this time, the <ao:html> tag does not implement StyleAttribute, so this should not be required when the style is within the <head>. However, inlining a stylesheet within some other tags, such as <ao:form>, will require forceElement="true".

    ]]>
    forceElement false true boolean
    Provides a tabindex attribute to its TabindexAttribute parent tag.

    The body, after trimming, must contain an integer or be empty. If empty, the tabindex attribute of the parent tag is not overridden.

    ]]>
    tabindex &package;.TabindexTag &JSP;
    Provides a target attribute to its TargetAttribute parent tag.

    ]]>
    target &package;.TargetTag &JSP;
    Renders a <textarea> tag.

    The value may be provided in one of three ways, in precedence order:

    1. Direct child <ao:value> tag.
    2. As the value attribute
    3. Contents of tag body.
    ]]>
    textarea &package;.TextareaTag &JSP; &GlobalBufferedAttributes; The number of columns for the textarea element.

    ]]>
    cols false true int
    The disabled attribute. Accepts values of true or false. A non-empty nested <ao:disabled> tag will override this value. If disabled is true, will add the attribute as disabled="disabled", otherwise the attribute is not added.

    ]]>
    disabled false true boolean
    The name of the textarea element. A nested <ao:name> tag will override this value.

    ]]>
    name false true java.lang.Object
    The readonly attribute. Accepts values of true or false. A non-empty nested <ao:readonly> tag will override this value. If readonly is true, will add the attribute as readonly="readonly", otherwise the attribute is not added.

    ]]>
    readonly false true boolean
    The number of rows for the textarea element.

    ]]>
    rows false true int
    The value of the textarea. A nested <ao:value> tag will override this value. If neither is provided, the output of the body is used.

    ]]>
    value false true java.lang.Object
    &OnchangeAttribute; true
    Provides a title attribute to its TitleAttribute parent tag.

    ]]>
    title &package;.TitleTag &JSP;
    Provides a type attribute to its TypeAttribute parent tag.

    ]]>
    type &package;.TypeTag &JSP;
    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.

    Before the first ? symbol, may contain characters in any language. This is more flexible than a strict URL format, these characters will be automatically encoded based on context.

    After the first ?, however, the parameters must be properly URL encoded and contain only valid characters. It should not be escaped for (X)HTML, meaning that parameter separators should be "&" instead of "&amp;". The proper escaping/encoding will be performed based on the context of this tag.

    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.

    Depending on context, the URL will be passed through HttpServletResponse.encodeURL to add any URL-based session state. Session state will never be added to external links.

    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 attribute that has no namespace and begins with param. is added to the URL as a 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.

    When in a CSS context, such as nested within <ao:style>, the URL is surrounded by url("…") and fully encoded as a CSS URL.

    The content type of this tag is text/url.

    To establish a URL context less URL manipulation, see also <encoding:url>.

    ]]>
    url &package;.UrlTag &JSP; When true, generates an absolute URL. 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 URL 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
    true
    Provides a value attribute to its ValueAttribute parent tag.

    ]]>
    value &package;.ValueTag &JSP;
    Like <c:when>, except uses deferred expressions.

    ]]>
    when com.aoapps.taglib.WhenTag JSP The condition to be evaluated, only evaluated as-needed due to use of deferred expressions.

    ]]>
    test true java.lang.Boolean
    Provides a width attribute to its WidthAttribute parent tag.

    ]]>
    width &package;.WidthTag &JSP;
    Word wraps the textual content.

    ]]>
    wordWrap &package;.WordWrapTag &JSP; The width to wrap to. Defaults to 79.

    ]]>
    width false true int
    Writes the bean contents. Supports data types beyond <c:out> and <bean:write>, such as XML nodes for HTML snippets.

    If the bean is null then nothing is displayed. This is generally for compatibility with Struts 1.X and predates JSTL and Expression Language. JSTL, Expression Language, and other tags should generally be preferred.

    The method attribute provides the name of the method that will be used to get the display value. If not provided, it will default to toString. This method searches for the method of the given name with no parameters. It is an error if the method is not found.

    The content type depends on the value provided to the type attribute, and defaults to text/plain. The content is checked for well-formedness based on its type:

    • css or text/css - must be well-formed CSS content. (Note: Currently only checks character values.)
    • javascript, application/javascript, or text/javascript - no validation
    • json or application/json - no validation
    • ld_json or application/ld+json - no validation
    • text or text/plain - no validation
    • url or text/url - must be a valid URL
    • xhtml or application/xhtml+xml - must be well-formed XHTML content. (Note: Currently only checks character values.)
    • xhtml_attribute or application/xhtml+xml+attribute - must be a valid XHTML attribute.
    • mysql or text/x+mysql - must be valid MySQL command "mysql" input
    • psql or text/x+psql - must be valid PostgreSQL command "psql" input
    • sh or text/x+sh - must be valid shell script
    ]]>
    write &package;.WriteTag com.aoapps.taglib.WriteTagTEI &JSP; Specifies the variable scope searched to retrieve the bean specified by name. If not specified, the default rules applied by JspContext.findAttribute() are applied.

    ]]>
    scope false true java.lang.String
    Specifies the attribute name of the bean whose property is accessed to retrieve the value specified by property (if specified). If property is not specified, the value of this bean itself will be used.

    A nested <ao:name> tag will override this value.

    ]]>
    name false true java.lang.Object
    Specifies the name of the property to be accessed on the bean specified by name. This value may be a simple, indexed, or nested property reference expression. If not specified, the bean identified by name will itself be used.

    ]]>
    property false true java.lang.String
    Specifies the method that will be used to convert the object to a String. This defaults to toString.

    ]]>
    method false true java.lang.String
    Specifies the type of content contained in the bean. Defaults to text/plain. A nested <ao:type> tag will override this value.

    ]]>
    type false true java.lang.Object
    Gets the lastModified timestamp in milliseconds since Epoch or 0 when not known.

    ]]>
    getLastModified com.aoapps.taglib.Functions long getLastModified(java.lang.String) ${ao:getLastModified('../path-to-page.jsp')}
    ]]> 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.

    ]]>
    addLastModified com.aoapps.taglib.Functions java.lang.String addLastModified(java.lang.String) ${ao:addLastModified('../path-to-page.jsp')}]]>
    Encodes a value for use in a URI path component, query string, or fragment.

    Encodes characters in the recommended UTF-8 encoding.

    ]]>
    encodeURIComponent com.aoapps.net.URIEncoder java.lang.String encodeURIComponent(java.lang.String) ${ao:encodeURIComponent(value)}]]>
    Decodes a value from use as a URI path component, query string, or fragment.

    Decodes characters in the recommended UTF-8 encoding.

    ]]>
    decodeURIComponent com.aoapps.net.URIDecoder java.lang.String decodeURIComponent(java.lang.String) ${ao:decodeURIComponent(value)}]]>
    Encodes a URI to ASCII format.

    Encodes characters in the recommended UTF-8 encoding.

    ]]>
    encodeURI com.aoapps.net.URIEncoder java.lang.String encodeURI(java.lang.String) ${ao:encodeURI(value)}]]>
    Decodes a URI to Unicode format.

    Characters that would decode to a reserved character are left percent-encoded to avoid ambiguity.

    Decodes characters in the recommended UTF-8 encoding.

    ]]>
    decodeURI com.aoapps.net.URIDecoder java.lang.String decodeURI(java.lang.String) ${ao:decodeURI(value)}]]>
    Rewrites a URL to maintain session state or otherwise alter the URL mapping.

    Encodes the URI to ASCII format then passes through HttpServletResponse.encodeURL.

    Encodes characters in the recommended UTF-8 encoding.

    ]]>
    encodeURL com.aoapps.taglib.Functions java.lang.String encodeURL(java.lang.String) ${ao:encodeURL('../path-to-page.jsp')}]]>
    Resolves a possibly page-relative path to a context-absolute path.

    path: The absolute URL, context-absolute path, or page-relative path.

    ]]>
    getAbsolutePath com.aoapps.taglib.Functions java.lang.String getAbsolutePath(java.lang.String) ${ao:getAbsolutePath('../path-to-page.jsp')}]]>
    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.

    ]]>
    getAbsoluteURL com.aoapps.taglib.Functions java.lang.String getAbsoluteURL(java.lang.String) ${ao:getAbsoluteURL('/path-to-page.jsp')}]]>
    Gets a time span display for a given number of milliseconds or null for null milliseconds.

    ]]>
    getDecimalTimeLength com.aoapps.taglib.Functions java.lang.String getDecimalTimeLength(java.lang.Long) ${ao:getDecimalTimeLength(timeSpan)}]]>
    Gets the version of a Maven project given its groupId and artifactId.

    Searches in the following order:

    1. Look for a web resource META-INF/maven/groupId/artifactId/pom.properties, relative to the given lib directory (which itself is interpreted relative to the current page.

      This is for dependencies that have been expanded into the project as overlays.

    2. Next searches the application classpath via Projects.getVersion(String groupId, String artifactId).

      This is for dependencies that have been included as dependencies, most likely in the WEB-INF/lib folder.

    3. Finally, if not found, returns the provided default value. This default value will typically be set via a build-time filter, such as @{project.version}.

      This is to fallback to build-time dependencies when no runtime version information can be found.

    ]]>
    getProjectVersion com.aoapps.taglib.Functions java.lang.String getProjectVersion(java.lang.String,java.lang.String,java.lang.String,java.lang.String) ${ao:getProjectVersion(lib, groupId, artifactId, def)}]]>
    Determines if the current request has been forwarded by a <ao:forward> or <ao:redirect> tag.

    ]]>
    isForwarded com.aoapps.taglib.Functions boolean isForwarded() ${ao:isForwarded()}]]>
    Determines if the response locale is a right-to-left language.

    ]]>
    isRtl com.aoapps.taglib.Functions boolean isRtl() ${ao:isRtl()}]]>
    Joins elements of any Iterable into a String.

    ]]>
    join com.aoapps.taglib.Functions java.lang.String join(java.lang.Iterable,java.lang.String) ${ao:join(iterable, separator)}]]>
    Gets a value from the current localization bundle given its key. No parameters may be provided. Must be nested inside a <ao:bundle> tag.

    ]]>
    message com.aoapps.taglib.Functions java.lang.String message(java.lang.String) ${ao:message(key)}]]>
    Word wraps a String.

    ]]>
    wordWrap com.aoapps.lang.Strings java.lang.String wordWrap(java.lang.String,int) ${ao:wordWrap(text, width)}]]>
    Calls java.lang.Math.ceil(double).

    ]]>
    ceil java.lang.Math double ceil(double) ${ao:ceil(a)}]]>
    Calls java.lang.Math.floor(double).

    ]]>
    floor java.lang.Math double floor(double) ${ao:floor(a)}]]>
    Calls java.lang.Math.round(double).

    ]]>
    round java.lang.Math long round(double) ${ao:round(a)}]]>




    © 2015 - 2024 Weber Informatics LLC | Privacy Policy