org.apache.struts2.dojo.components
Class Div

java.lang.Object
  extended by org.apache.struts2.components.Component
      extended by org.apache.struts2.components.UIBean
          extended by org.apache.struts2.components.ClosingUIBean
              extended by org.apache.struts2.dojo.components.AbstractRemoteBean
                  extended by org.apache.struts2.dojo.components.Div
All Implemented Interfaces:
RemoteBean

public class Div
extends AbstractRemoteBean

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:

Examples

<sx:div href="%{#url}">Initial Content</sx:div> <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> <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>


Field Summary
protected  java.lang.String autoStart
           
protected  java.lang.String closable
           
static java.lang.String COMPONENT_NAME
           
protected  java.lang.String delay
           
protected  java.lang.String preload
           
protected  java.lang.String refreshOnShow
           
protected  java.lang.String startTimerListenTopics
           
protected  java.lang.String stopTimerListenTopics
           
static java.lang.String TEMPLATE
           
static java.lang.String TEMPLATE_CLOSE
           
protected  java.lang.String updateFreq
           
 
Fields inherited from class org.apache.struts2.dojo.components.AbstractRemoteBean
afterNotifyTopics, beforeNotifyTopics, errorNotifyTopics, errorText, executeScripts, formFilter, formId, handler, highlightColor, highlightDuration, href, indicator, listenTopics, loadingText, notifyTopics, parseContent, separateScripts, showErrorTransportText, showLoadingText, transport
 
Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, value
 
Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, parameters, stack
 
Constructor Summary
Div(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 void evaluateExtraParams()
           
 java.lang.String getDefaultOpenTemplate()
           
protected  java.lang.String getDefaultTemplate()
           
 void setAutoStart(java.lang.String autoStart)
           
 void setClosable(java.lang.String closable)
           
 void setDelay(java.lang.String delay)
           
 void setHighlightColor(java.lang.String highlightColor)
           
 void setPreload(java.lang.String preload)
           
 void setRefreshOnShow(java.lang.String refreshOnShow)
           
 void setStartTimerListenTopics(java.lang.String startTimerListenTopic)
           
 void setStopTimerListenTopics(java.lang.String stopTimerListenTopic)
           
 void setUpdateFreq(java.lang.String updateInterval)
           
 
Methods inherited from class org.apache.struts2.dojo.components.AbstractRemoteBean
getTheme, setAfterNotifyTopics, setBeforeNotifyTopics, setCssClass, setCssStyle, setErrorNotifyTopics, setErrorText, setExecuteScripts, setFormFilter, setFormId, setHandler, setHighlightDuration, setHref, setId, setIndicator, setListenTopics, setLoadingText, setName, setNotifyTopics, setParseContent, setSeparateScripts, setShowErrorTransportText, setShowLoadingText, setTheme, setTransport
 
Methods inherited from class org.apache.struts2.components.ClosingUIBean
setOpenTemplate, start
 
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getId, getTemplate, getTemplateDir, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssErrorClass, setCssErrorStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setValue
 
Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE
See Also:
Constant Field Values

TEMPLATE_CLOSE

public static final java.lang.String TEMPLATE_CLOSE
See Also:
Constant Field Values

COMPONENT_NAME

public static final java.lang.String COMPONENT_NAME

updateFreq

protected java.lang.String updateFreq

autoStart

protected java.lang.String autoStart

delay

protected java.lang.String delay

startTimerListenTopics

protected java.lang.String startTimerListenTopics

stopTimerListenTopics

protected java.lang.String stopTimerListenTopics

refreshOnShow

protected java.lang.String refreshOnShow

closable

protected java.lang.String closable

preload

protected java.lang.String preload
Constructor Detail

Div

public Div(com.opensymphony.xwork2.util.ValueStack stack,
           javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
Method Detail

getDefaultOpenTemplate

public java.lang.String getDefaultOpenTemplate()
Specified by:
getDefaultOpenTemplate in class org.apache.struts2.components.ClosingUIBean

getDefaultTemplate

protected java.lang.String getDefaultTemplate()
Specified by:
getDefaultTemplate in class org.apache.struts2.components.UIBean

evaluateExtraParams

public void evaluateExtraParams()
Overrides:
evaluateExtraParams in class AbstractRemoteBean

setAutoStart

public void setAutoStart(java.lang.String autoStart)

setDelay

public void setDelay(java.lang.String delay)

setUpdateFreq

public void setUpdateFreq(java.lang.String updateInterval)

setStartTimerListenTopics

public void setStartTimerListenTopics(java.lang.String startTimerListenTopic)

setStopTimerListenTopics

public void setStopTimerListenTopics(java.lang.String stopTimerListenTopic)

setRefreshOnShow

public void setRefreshOnShow(java.lang.String refreshOnShow)

setClosable

public void setClosable(java.lang.String closable)

setPreload

public void setPreload(java.lang.String preload)

setHighlightColor

public void setHighlightColor(java.lang.String highlightColor)
Specified by:
setHighlightColor in interface RemoteBean
Overrides:
setHighlightColor in class AbstractRemoteBean


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.