Index
- NAME
- SYNOPSIS
- DESCRIPTION
- PARAMETER DESCRIPTIONS
- AUTHOR
- SEE ALSO
NAME
HTML::AjaxTags - AjaxTags implementation
SYNOPSIS
use HTML::AjaxTags;
DESCRIPTION
HTML::AjaxTags is a re-write of AjaxTags (http://ajaxtags.sourceforge.net/index.html) for perl.
Most of the following documentation was taken directly from the AjaxTags web site. Changes were made to accommodate for calling AjaxTags methods though perl instead of jsp tags.
PARAMETER DESCRIPTIONS
The following parameters can be used in multiple HTML::AjaxTags methods. The avilabiliy and required use of each parameter will be listed under the description for the method itself.
- * baseUrl
- * source
- * sourceClass
- * target
- * parameters
- * eventType
- * postFunction
- * emptyFunction
- * errorFunction
URL of server-side action or servlet that processes search and returns list of values used in autocomplete dropdown; expression language (EL) is supported for this field
Text field where label of autocomplete selection will be populated; also the field in which the user types out the search string
The CSS class name of the elements to which the callout will be attached
Text field where value of autocomplete selection will be populated
A comma-separated list of parameters to pass to the server-side action or servlet
Specifies the event type to attach to the source field(s)
Function to execute after Ajax is finished, allowing for a chain of additional functions to execute
Function to execute if there is an empty response
Function to execute if there is a server exception (non-200 HTTP response)
autoComplete(%params)
The autocomplete tag allows one to retrieve a list of probable values from a backend servlet (or other server-side control) and display them in a dropdown beneath an HTML text input field. The user may then use the cursor and ENTER keys or the mouse to make a selection from that list of labels, which is then populated into the text field. This JSP tag also allows for a second field to be populated with the value or ID of the item in the dropdown.
- Required Parameters
- * baseUrl
- * source
- * target
- * parameters
- * className
- Optional Parameters
- * indicator
- * appendSeparator
- * minimumCharacters
- * var
- * attachTo
CSS class name to apply to the popup autocomplete dropdown
ID of indicator region that will show during Ajax request call
The separator to use for the target field when values are appended [default=space]. If appendValue is not set or is set to "false", this parameter has no effect.
Minimum number of characters needed before autocomplete is executed
Name of the JavaScript object created
Name of the JavaScript object to which autocompleter will attach. You must define 'var' for this to work.
callout(%params)
The callout tag is an easy way to attach a callout or popup balloon to any HTML element supporting an onclick event. The style of this callout is fairly flexible, but generally has a header/title, a close link ('X'), and the content itself, of course. All of this (since AjaxTags 1.2) is handled by the OverLIBMWS JavaScript library. See http://www.macridesweb.com/oltest/ for complete instructions on using OverLIBMWS.
- Required Parameters
- * baseUrl
- * source OR sourceClass
- * parameters
- Optional Parameters
- * var
- * attachTo
- * title
- * overlib
- * preFunction
- * postFunction
- * errorFunction
Name of the JavaScript object created
Name of the JavaScript object to which callout will attach. You must define 'var' for this to work.
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.
Options for OverLib
htmlContent(%params)
The HTML content tag allows you to fill a region on the page (often a DIV tag) with any HTML content pulled from another webpage. The AJAX action may be activated by attaching it to an anchor link or form field.
This tag expects an HTML response instead of XML and the AJAX function will not parse it as XML; it will simply insert the content of the response as is.
- Required Parameters
- * baseUrl
- * source OR sourceClass
- * target
- * parameters
- Optional Parameters
- * var
- * attachTo
- * eventType
- * postFunction
- * errorFunction
Name of the JavaScript object created
Name of the JavaScript object to which htmlContent will attach. You must define 'var' for this to work.
portlet(%params)
The portlet tag simulates a a href="http://www.jcp.org/en/jsr/detail?id=168"JSR-168/a style portlet by allowing you to define a portion of the page that pulls content from another location using Ajax with or without a periodic refresh.
This tag expects an HTML response instead of XML and the AJAX function will not parse it as XML; it will simply insert the content of the response as is.
- Required Parameters
- * baseUrl
- * source
- * title
- * classNamePrefix
- Optional Parameters
- * var
- * attachTo
- * parameters
- * postFunction
- * emptyFunction
- * errorFunction
- * imageClose
- * imageMaximize
- * imageMinimize
- * imageRefresh
- * refreshPeriod
- * executeOnLoad
- * expireDays
- * expireHours
- * expireMinutes
Title for portlet header
CSS class name prefix to use for the portlet's 'Box', 'Tools', 'Refresh', 'Size', 'Close', 'Title', and 'Content' elements
Name of the JavaScript object created
Name of the JavaScript object to which portlet will attach. You must define 'var' for this to work.
Image used for the close icon
Image used for the maximize icon
Image used for the minimize icon
Image used for the refresh icon
The time (in seconds) the portlet waits before automatically refreshing its content. If no period is specified, the portlet will not refresh itself automatically, but must be commanded to do so by clicking the refresh image/link (if one is defined). Lastly, the refresh will not occur until after the first time the content is loaded, so if executeOnLoad is set to false, the refresh will not begin until you manually refresh the first time.
Indicates whether the portlet's content should be retrieved when the page loads [default=true]
Number of days cookie should persist
Number of hours cookie should persist
Number of minutes cookie should persist
select(%params)
The select tag allows one to retrieve a list of values from a backend servlet (or other server-side control) and display them in another HTML select box.
- Required Parameters
- * baseUrl
- * source
- * target
- Optional Parameters
- * var
- * attachTo
- * parameters
- * eventType
- * defaultOptions
- * executeOnLoad
- * preFunction
- * postFunction
- * errorFunction
- * parser
Name of the JavaScript object created
Name of the JavaScript object to which select will attach. You must define 'var' for this to work.
Specifies the event type to attach to the source field(s)
A comma-seperated list of values of options to be marked as selected by default if they exist in the new set of options
Indicates whether the target select/dropdown should be populated when the object is initialized (this is essentially when the form loads) [default=false]
The response parser to implement [default=ResponseHtmlParser]
tabPanel(%params)
Provides a tabbed page view of content from different resources.
- Required Parameters
- * panelStyleId
- * contentStyleId
- * currentStyleId
- * tab
- * baseUrl
- * caption
-
Optional aruments include:
- * parameters
- * defaultTab
Indicates whether this tab is the initial one loaded [true|false]
- Optional Parameters
- * var
- * attachTo
- * preFunction
- * postFunction
- * errorFunction
- * parser
Tab is an array reference of hash references. Each hash reference describes a single tab in the tabPanel. Each hash reference must include:
The caption for this tab
Name of the JavaScript object created
Name of the JavaScript object to which tabPanel will attach. You must define 'var' for this to work.
The response parser to implement [default=ResponseHtmlParser]
toggle(%params)
The toggle tag will change the value of a hidden form field between true and false, toggle an image between two source files, and replace the inner HTML content of another tag (div, span, etc).
- Required Parameters
- * baseUrl
- * image
- * state
- * stateXmlName
- * imagePattern
- Optional Parameters
- * parameters
- * eventType
- * postFunction
- * emptyFunction
- * errorFunction
Image tag ID that will be toggled on/off
ID of hidden form field used to hold the current state
Name of the XML property specifying the state in the returning XML
URL pattern of images used to indicate different status
updateField(%params)
Builds the JavaScript required to update one or more form fields based on the value of another single field.
- Required Parameters
- * baseUrl
- * source
- * target
- * parameters
- * action
- Optional Parameters
- * eventType
- * postFunction
- * emptyFunction
- * errorFunction
ID of form button or image tag that will fire the onclick event
AUTHOR
Kevin McGrath, kmcgrath@baknet.com
SEE ALSO
perl(1)