Fork me on GitHub
Edit on GitHub

dojo div

Description

This tag generates an HTML div that loads its content using an XMLHttpRequest call, via the dojo framework. When the "updateFreq" is set the built in timer will start automatically and reload the div content with the value of "updateFreq" as the refresh period(in milliseconds). Topics can be used to stop(stopTimerListenTopics) and start(startTimerListenTopics) this timer.

When used inside a "tabbedpanel" tag, each div becomes a tab. Some attributes are specific to this use case, like:

Parameters

Dynamic Attributes Allowed:

false
 

Name

Required

Default

Evaluated

Type

Description

accesskey false false String Set the html accesskey attribute on rendered html element
afterNotifyTopics false false String Comma delimmited list of topics that will published after the request(if the request succeeds)
autoStart false true false Boolean Start timer automatically
beforeNotifyTopics false false String Comma delimmited list of topics that will published before the request
closable false false false String Show a close button when the div is inside a 'tabbedpanel'
cssClass false false String The css class to use for element
cssErrorClass false false String The css error class to use for element
cssErrorStyle false false String The css error style definitions for element to use
cssStyle false false String The css style to use for element
delay false false Integer How long to wait before fetching the content (in milliseconds)
disabled false false String Set the html disabled attribute on rendered html element
errorNotifyTopics false false String Comma delimmited list of topics that will published after the request(if the request fails)
errorPosition false false String Define error position of form element (top|bottom)
errorText false false String The text to display to the user if the is an error fetching the content
executeScripts false false false Boolean Javascript code in the fetched content will be executed
formFilter false false String Function name used to filter the fields of the form.
formId false false String Form id whose fields will be serialized and passed as parameters
handler false false String Javascript function name that will make the request
highlightColor false none false String Color used to perform a highlight effect on this element
highlightDuration false 2000 false Integer Duration of highlight effect in milliseconds. Only valid if 'highlightColor' attribute is set
href false false String The URL to call to obtain the content. Note: If used with ajax context, the value must be set as an url tag value.
id false false String The id to use for the element
indicator false false String Id of element that will be shown while making request
javascriptTooltip false false false Boolean Use JavaScript to generate tooltips
key false false String Set the key (name, value, label) for this particular component
label false false String Label expression used for rendering an element specific label
labelSeparator false : false String String that will be appended to the label
labelposition false false String Define label position of form element (top/left)
listenTopics false false String Topic that will trigger the remote call
loadingText false Loading... false String Text to be shown while content is being fetched
name false false String The name to set for element
notifyTopics false false String Comma delimmited list of topics that will published before and after the request, and on errors
onblur false false String Set the html onblur attribute on rendered html element
onchange false false String Set the html onchange attribute on rendered html element
onclick false false String Set the html onclick attribute on rendered html element
ondblclick false false String Set the html ondblclick attribute on rendered html element
onfocus false false String Set the html onfocus attribute on rendered html element
onkeydown false false String Set the html onkeydown attribute on rendered html element
onkeypress false false String Set the html onkeypress attribute on rendered html element
onkeyup false false String Set the html onkeyup attribute on rendered html element
onmousedown false false String Set the html onmousedown attribute on rendered html element
onmousemove false false String Set the html onmousemove attribute on rendered html element
onmouseout false false String Set the html onmouseout attribute on rendered html element
onmouseover false false String Set the html onmouseover attribute on rendered html element
onmouseup false false String Set the html onmouseup attribute on rendered html element
onselect false false String Set the html onselect attribute on rendered html element
openTemplate false false String Set template to use for opening the rendered html.
parseContent false true false Boolean Parse returned HTML for Dojo widgets
preload false true false Boolean Load content when page is loaded
refreshOnShow false false false Boolean Content will be loaded when div becomes visible, used only inside the tabbedpanel tag
requiredLabel false false false Boolean If set to true, the rendered element will indicate that input is required
requiredPosition false false String Define required position of required form element (left|right)
separateScripts false true false String Run scripts in a separate scope, unique for each tag
showErrorTransportText false true false Boolean Set whether errors will be shown or not
showLoadingText false false false Boolean Show loading text on targets
startTimerListenTopics false false String Topics that will start the timer (for autoupdate)
stopTimerListenTopics false false String Topics that will stop the timer (for autoupdate)
style false false String The css style definitions for element to use - it's an alias of cssStyle attribute.
tabindex false false String Set the html tabindex attribute on rendered html element
template false false String The template (other than default) to use for rendering the element
templateDir false false String The template directory.
theme false false String The theme (other than default) to use for rendering the element
title false false String Set the html title attribute on rendered html element
tooltip false false String Set the tooltip of this particular component
tooltipConfig false false String Deprecated. Use individual tooltip configuration attributes instead.
tooltipCssClass false StrutsTTClassic false String CSS class applied to JavaScrip tooltips
tooltipDelay false Classic false String Delay in milliseconds, before showing JavaScript tooltips
tooltipIconPath false false String Icon path used for image that will have the tooltip
transport false XMLHTTPTransport false String Transport used by Dojo to make the request
updateFreq false false Integer How often to reload the content (in milliseconds)
value false false String Preset the value of input element.

Examples

Simple div that loads its content once:

 <sx:div href="%{#url}">Initial Content</sx:div>

div that reloads its content every 2 seconds, and shows an indicator while reloading:

 <img id="indicator" src="${pageContext.request.contextPath}/images/indicator.gif" style="display:none"/>
 <sx:div href="%{#url}" updateFreq="2000" indicator="indicator">
   Initial Content
 </sx:div>

div that uses topics to control the timer, highlights its content in red after reload, and submits a form:

 <form id="form">
   <label for="textInput">Text to be submited when div reloads</label>
   <input type=textbox id="textInput" name="data">
 </form>
 <sx:div 
      href="%{#url}" 
      updateFreq="3000"
      listenTopics="/refresh"
      startTimerListenTopics="/startTimer"
      stopTimerListenTopics="/stopTimer"
      highlightColor="red"
      formId="form">
  Initial Content
 </sx:div>