...
These attributes are common to all the ajax tags:
Attribute | Description | ExampleType |
---|---|---|
href | url used to make the request | /AjaxTest.actionString |
beforeLoading | Javascript code which will be executed before the request is made | alert('before!');String |
afterLoading | Javascript code which will be executed after the request is made | alert('after!');String |
Div
The div tag is a content area that can load its content asynchronously. The div tag can be forced to reload its content using a topic. To defined the topic that will trigger the refresh of the panel, use the "refreshListenTopic" attribute.
...
Code Block | ||||
---|---|---|---|---|
| ||||
<s:div theme="ajax" href="/AjaxTest.action" refreshListenTopic="/refresh"/> |
To publish the this topic of this example useuse this in your Javascript code:
Code Block | ||||
---|---|---|---|---|
| ||||
dojo.event.topic.publish("/refresh"); |
The div tag can be configured to update its content periodically, using a timer. Use the "updateInterval" attribute to set the interval used to refresh the content, for the mentioned timer; this value is expressed in milliseconds. If "autoStart" is set to true, "delay" can be used to force the timer to wait for the "delay"(in milliseconds also) period before starting. Delay is expressed in milliseconds.
This div will refresh periodically every 2 seconds, starting 3 seconds after the page is loaded:
...
There is an "autoStart" attribute that controls whether the timer will be started when the page is loaded. This attribute , its value is "true" by default. The timer can be started and stoped stopped using topics through the attributes using "startTimerListenTopic" and "stopTimerListenTopic".
This div will not start the timer by default and will listen to the start/stop topics to start its control the timer:
Code Block | ||||
---|---|---|---|---|
| ||||
<s:div theme="ajax" href="/AjaxTest.action" startTimerListenTopic="/startTimer" stopTimerListenTopic="/stopTimer" updateInterval="3000" autoStart="false"/> |
...
If the loaded text contains javascript Javascript code sections, these sections will be evaluated by the div tag executed if the "executeScripts" attribute is set to true.
If parameters need to be passed to the url, the "formId" attribute can be used to specify a form whose fields will be serialized and passed on the request as parameters. The attribute "formFilter" can bet set to the name of a javascript Javascript function that will be used to filter the fields of "formId". The "formFilter" function will be called for each field, passing the field as a parameter, and must return true if the field is to be included, or false otherwise.
This div will submit the field "firstName", of the form "userData" and ignore other fields:
...
If the attribute "handler" is set, the javascript Javascript function specified by its value will be called, instead of making the request. Use the "handler" function when you want to handle the request yourself.
This div will not make any request, and will just call the function "handler". The first parameter of the function is the Dojo widget for the div, and the second the DOM node for the div.
Code Block | ||||
---|---|---|---|---|
| ||||
<script type="text/javascript">
function handler(widget, node) {
alert('I will handle this myself!');
node.innerHTML = "Done";
}
</script>
<s:div theme="ajax" href="/AjaxTest.action" handler="handler"/>
|
Attribute | Description | Type |
---|---|---|
handler | Javascript function name that will make the request | String |
formId | Form id whose fields will be serialized and passed as parameters | String |
formFilter | Function name used to filter the fields of the form | String |
loadingText | The text to display in the "targets" while content is loaded | String |
errorText | The text to display in the "targets" when there is an error | String |
refreshListenTopic | Topic name that will cause the "targets" content to be reloaded | String |
startTimerListenTopic | Topic name that will start the timer | String |
stopTimerListenTopic | Topic name that will stop the timer | String |
executeScripts | Javascript code in the loaded content will be executed | Boolean |
updateInterval | Time between requests (in milliseconds) | Integer |
delay | Time to wait before making the first request(in milliseconds) | Integer |
autoStart | Start timer automatically when page loads | Boolean |
Submit
The submit tag can be used to update the content of its "targets" attribute with text returned from the asynchronous request. "targets" is a comma-delimited list of element ids.
Regular submit button that will update the content of div1:
Code Block | ||||
---|---|---|---|---|
| ||||
<div id="div1">Div 1</div>
<s:submit type="submit" theme="ajax" value="submit" targets="div1" href="/AjaxTest.action"/>
|
Submit button using an image:
Code Block | ||||
---|---|---|---|---|
| ||||
<div id="div1">Div 1</div>
<s:submit type="image" theme="ajax" label="Alt Text" targets="div1" src="${pageContext.request.contextPath}/images/struts-rocks.gif" href="/AjaxTest.action"/>
|
If the submit button is used inside a form, the form will be submitted asynchronously:
Code Block | ||||
---|---|---|---|---|
| ||||
<s:form id="form" action="AjaxTest">
<input type="textbox" name="data">
<s:submit type="button" theme="ajax" label="Update Content"/>
</s:form>
|
A submit button can be used to submit a form, even if it is outside the form, using "formId" and "formFilter" and "href". Note that in this case "href" is required.
Code Block | ||||
---|---|---|---|---|
| ||||
<s:form id="form1"> <input type="textbox" name="data"> </s:form> <s:submit type="submit" theme="ajax" href="/AjaxTest.action" formId="form1"/> |
See the Div tag for examples on how to use "handler", "beforeLoading", "afterLoading", "loadingText" and "errorText"
Attribute | Description | Type |
---|---|---|
targets | Comma delimited list of ids of the elements whose content will be updated | String |
handler | Javascript function name that will make the request | String |
formId | Form id whose fields will be serialized and passed as parameters | String |
formFilter | Function name used to filter the fields of the form | String |
loadingText | The text to display in the "targets" while content is loaded | String |
errorText | The text to display in the "targets" when there is an error | String |
refreshListenTopic | Topic name that will cause the "targets" content to be reloaded | String |
executeScripts | Javascript code in the loaded content will be executed | Boolean |
Anchor
The anchor tag like the submit tag can be used to update the content of its "targets" attribute with text returned from the asynchronous request. "targets" is a comma-delimited list of element ids.
This anchor will update the content of div1 and div2 with text returned form "/AjaxTest.action"
Code Block | ||||
---|---|---|---|---|
| ||||
<div id="div1">Div 1</div>
<div id="div2">Div 2</div>
<s:a theme="ajax" href="/AjaxTest.action" targets="dev1,dev2">Update divs</s:a>
|
See the Div tag for examples on how to use "handler", "beforeLoading", "afterLoading", "loadingText" and "errorText"
Attribute | Description | Type |
---|---|---|
targets | Comma delimited list of ids of the elements whose content will be updated | String |
handler | Javascript function name that will make the request | String |
formId | Form id whose fields will be serialized and passed as parameters | String |
formFilter | Function name used to filter the fields of the form | String |
loadingText | The text to display in the "targets" while content is loaded | String |
errorText | The text to display in the "targets" when there is an error | String |
refreshListenTopic | Topic name that will cause the "targets" content to be reloaded | String |
executeScripts | Javascript code in the loaded content will be executed | Boolean |