Render HTML div providing content from remote call via AJAX
The div tag is primarily an AJAX tag, providing a remote call from the current page to update a section of content without having to refresh the entire page.
It creates a HTML <DIV /> that obtains it's content via a remote XMLHttpRequest call via the dojo framework. If a "listenTopics" is supplied, it will listen to that topic and refresh it's content when any message is received. Important: Be sure to setup the page containing this tag to be Configured for AJAX Examples<a:div ... />
Name |
Required |
Default |
Type |
Description |
|---|---|---|---|---|
| updateFreq | false | 0 | Integer | How often to re-fetch the content (in milliseconds) |
| delay | false | 0 | Integer | How long to wait before fetching the content (in milliseconds) |
| loadingText | false | Object/String | The text to display to the user while the new content is being fetched (especially good if the content will take awhile) | |
| listenTopics | false | Object/String | Topic name to listen to (comma delimited), that will cause the DIV's content to be re-fetched | |
| theme | false | String | The theme to use for the element. This tag will usually use the ajax theme. | |
| href | false | String | The URL to call to obtain the content | |
| errorText | false | String | The text to display to the user if the is an error fetching the content | |
| showErrorTransportText | false | false | Boolean | when to show the error message as content when the URL had problems |
| afterLoading | false | String | Javascript code that will be executed after the content has been fetched | |
| openTemplate | false | Object/String | Set template to use for opening the rendered html. | |
| templateDir | false | Object/String | The template directory. | |
| template | false | Object/String | The template (other than default) to use for rendering the element | |
| cssClass | false | Object/String | The css class to use for element | |
| cssStyle | false | Object/String | The css style definitions for element ro use | |
| title | false | Object/String | Set the html title attribute on rendered html element | |
| disabled | false | Object/String | Set the html disabled attribute on rendered html element | |
| label | false | Object/String | Label expression used for rendering a element specific label | |
| labelposition | false | Object/String | define label position of form element (top/left) | |
| requiredposition | false | Object/String | define required position of required form element (left|right) | |
| name | false | Object/String | The name to set for element | |
| required | false | false | Boolean | If set to true, the rendered element will indicate that input is required |
| tabindex | false | Object/String | Set the html tabindex attribute on rendered html element | |
| value | false | Object/String | Preset the value of input element. | |
| onclick | false | Object/String | Set the html onclick attribute on rendered html element | |
| ondblclick | false | Object/String | Set the html ondblclick attribute on rendered html element | |
| onmousedown | false | Object/String | Set the html onmousedown attribute on rendered html element | |
| onmouseup | false | Object/String | Set the html onmouseup attribute on rendered html element | |
| onmouseover | false | Object/String | Set the html onmouseover attribute on rendered html element | |
| onmousemove | false | Object/String | Set the html onmousemove attribute on rendered html element | |
| onmouseout | false | Object/String | Set the html onmouseout attribute on rendered html element | |
| onfocus | false | Object/String | Set the html onfocus attribute on rendered html element | |
| onblur | false | Object/String | Set the html onblur attribute on rendered html element | |
| onkeypress | false | Object/String | Set the html onkeypress attribute on rendered html element | |
| onkeydown | false | Object/String | Set the html onkeydown attribute on rendered html element | |
| onkeyup | false | Object/String | Set the html onkeyup attribute on rendered html element | |
| onselect | false | Object/String | Set the html onselect attribute on rendered html element | |
| onchange | false | Object/String | Set the html onchange attribute on rendered html element | |
| accesskey | false | Object/String | Set the html accesskey attribute on rendered html element | |
| tooltip | false | String | Set the tooltip of this particular component | |
| tooltipConfig | false | String | Set the tooltip configuration | |
| id | false | Object/String | id for referencing element. For UI and form tags it will be used as HTML id attribute |