ajaxtags.tld

The AJAX JSP Tag Library is a set of JSP tags that simplify the use of Asynchronous JavaScript and X

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE taglib
  PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"
  "http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

<taglib xmlns="http://java.sun.com/JSP/TagLibraryDescriptor">
  <tlib-version>1.0</tlib-version>
  <jsp-version>1.2</jsp-version>
  <short-name>Ajax Tag Library</short-name>
  <uri>http://ajaxtags.org/tags/ajax</uri>
  <description>Ajax Tag Library</description>

  <tag>
    <name>select</name>
    <tag-class>org.ajaxtags.tags.AjaxSelectTag</tag-class>
    <description>
      Builds the JavaScript required to populate a select box based on some event.
    </description>

    <attribute>
      <name>fieldId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        The initial select field that will form the basis for the search via AJAX
      </description>
    </attribute>

    <attribute>
      <name>targetId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Select field where value of AJAX search will be populated</description>
    </attribute>

    <attribute>
      <name>baseUrl</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        URL of server-side action or servlet that processes search and returns list of values used
        in target select field
      </description>
    </attribute>

    <attribute>
      <name>paramName</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Name of parameter used to pass search string to server-side action or servlet
      </description>
    </attribute>

    <attribute>
      <name>postFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute after Ajax is finished, allowing for a chain of additional functions to
        execute
      </description>
    </attribute>

    <attribute>
      <name>emptyFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is an empty response
      </description>
    </attribute>

    <attribute>
      <name>errorFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is a server exception (non-200 HTTP response)
      </description>
    </attribute>
  </tag>

  <tag>
    <name>autocomplete</name>
    <tag-class>org.ajaxtags.tags.AjaxAutocompleteTag</tag-class>
    <description>
      Builds the JavaScript required to populate an input field as the user types.
    </description>

    <attribute>
      <name>fieldId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Text field where label of autocomplete selection will be populated; also the field in which
        the user types out the search string
      </description>
    </attribute>

    <attribute>
      <name>popupId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>ID of div tag used to show available choices in autocomplete</description>
    </attribute>

    <attribute>
      <name>targetId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Text field where value of autocomplete selection will be populated</description>
    </attribute>

    <attribute>
      <name>baseUrl</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        URL of server-side action or servlet that processes search and returns list of values used
        in autocomplete dropdown
      </description>
    </attribute>

    <attribute>
      <name>paramName</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Name of parameter used to pass search string to server-side action or servlet
      </description>
    </attribute>

    <attribute>
      <name>className</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>CSS class name to apply to the popup autocomplete dropdown</description>
    </attribute>

    <attribute>
      <name>postFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute after Ajax is finished, allowing for a chain of additional functions to
        execute
      </description>
    </attribute>

    <attribute>
      <name>progressStyle</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Used to define a CSS style that places an icon in the input field</description>
    </attribute>

    <attribute>
      <name>minimumCharacters</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Minimum number of characters needed before autocomplete is executed</description>
    </attribute>
  </tag>

  <tag>
    <name>toggle</name>
    <tag-class>org.ajaxtags.tags.AjaxToggleTag</tag-class>
    <description>Builds the JavaScript required to toggle an image on/off.</description>

    <attribute>
      <name>imageId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Image tag ID that will be toggled on/off</description>
    </attribute>

    <attribute>
      <name>targetId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>ID of div tag used to show HTML/text response, if any</description>
    </attribute>

    <attribute>
      <name>stateId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>ID of hidden form field used to hold the current state</description>
    </attribute>

    <attribute>
      <name>baseUrl</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        URL of server-side action or servlet that processes a simple command from a toggle action;
        responds with a single option value and label
      </description>
    </attribute>

    <attribute>
      <name>paramName</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Name of parameter used to pass search string to server-side action or servlet
      </description>
    </attribute>

    <attribute>
      <name>imageOn</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>URL of image used to indicate ON status</description>
    </attribute>

    <attribute>
      <name>imageOff</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>URL of image used to indicate OFF status</description>
    </attribute>

    <attribute>
      <name>postFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute after Ajax is finished, allowing for a chain of additional functions to
        execute
      </description>
    </attribute>

    <attribute>
      <name>emptyFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is an empty response
      </description>
    </attribute>

    <attribute>
      <name>errorFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is a server exception (non-200 HTTP response)
      </description>
    </attribute>
  </tag>

  <tag>
    <name>updateField</name>
    <tag-class>org.ajaxtags.tags.AjaxFormFieldTag</tag-class>
    <description>
      Builds the JavaScript required to update one or more form fields based on the value of another
      single field.
    </description>

    <attribute>
      <name>sourceId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>The form field that will hold the parameter passed to the servlet</description>
    </attribute>

    <attribute>
      <name>targetId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>A comma-delimited list of form field IDs that will be populated with results</description>
    </attribute>

    <attribute>
      <name>actionId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>ID of form button or image tag that will fire the onclick event</description>
    </attribute>

    <attribute>
      <name>baseUrl</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        URL of server-side action or servlet that processes a simple command
      </description>
    </attribute>

    <attribute>
      <name>paramName</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Name of parameter used to pass search string to server-side action or servlet
      </description>
    </attribute>

    <attribute>
      <name>postFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute after Ajax is finished, allowing for a chain of additional functions to
        execute
      </description>
    </attribute>

    <attribute>
      <name>emptyFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is an empty response
      </description>
    </attribute>

    <attribute>
      <name>errorFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is a server exception (non-200 HTTP response)
      </description>
    </attribute>
  </tag>

  <tag>
    <name>callout</name>
    <tag-class>org.ajaxtags.tags.AjaxCalloutTag</tag-class>
    <description>
      Builds the JavaScript required to hook a callout or popup balloon to a link, image, or other
      HTML element's onclick event.
    </description>

    <attribute>
      <name>anchorId</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>The HTML element to hook the callout to via it's onclick event</description>
    </attribute>

    <attribute>
      <name>classNamePrefix</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        CSS class name prefix to use for the callout's 'Box', 'Close', and 'Content' elements
      </description>
    </attribute>

    <attribute>
      <name>baseUrl</name>
      <required>true</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        URL of server-side action or servlet that processes a simple command
      </description>
    </attribute>

    <attribute>
      <name>paramName</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Name of parameter used to pass search string to server-side action or servlet
      </description>
    </attribute>

    <attribute>
      <name>paramValue</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Value of query parameter to pass to server-side action or servlet</description>
    </attribute>

    <attribute>
      <name>boxPosition</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Position of callout relative to anchor (e.g., 'top-left', 'top-right' [default],
        'bottom-left', or 'bottom-right')
      </description>
    </attribute>

    <attribute>
      <name>useTitleBar</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>Indicated whether the title bar should be rendered.</description>
    </attribute>

    <attribute>
      <name>title</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Title for callout's box header. If useTitleBar==false and no title is specified, then the
        value attribute of the returned XML will be used as the title.
      </description>
    </attribute>

    <attribute>
      <name>timeout</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Timeout setting for callout in milliseconds. No timeout will be used by default.
      </description>
    </attribute>

    <attribute>
      <name>postFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute after Ajax is finished, allowing for a chain of additional functions to
        execute
      </description>
    </attribute>

    <attribute>
      <name>emptyFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is an empty response
      </description>
    </attribute>

    <attribute>
      <name>errorFunc</name>
      <required>false</required>
      <rtexprvalue>true</rtexprvalue>
      <description>
        Function to execute if there is a server exception (non-200 HTTP response)
      </description>
    </attribute>
  </tag>

</taglib>