org.hdiv.components
Class SubmitHDIV

java.lang.Object
  org.apache.struts2.components.Component
      org.apache.struts2.components.UIBean
          org.apache.struts2.components.FormButton
              org.apache.struts2.components.Submit
                  org.hdiv.components.SubmitHDIV

All Implemented Interfaces:

org.apache.struts2.components.RemoteUICallBean

public class SubmitHDIV
extends org.apache.struts2.components.Submit

Render a submit button. The submit tag is used together with the form tag to provide asynchronous form submissions. The submit can have three different types of rendering:

• input: renders as html <input type="submit"...>
• image: renders as html <input type="image"...>
• button: renders as html <button type="submit"...>

Please note that the button type has advantages by adding the possibility to seperate the submitted value from the text shown on the button face, but has issues with Microsoft Internet Explorer at least up to 6.0

Examples

 
 <s:submit value="%{'Submit the form'}" />
 
 

 
 Render an image submit:
 <s:submit type="image" value="%{'Submit the form'}" src="submit.gif"/>
 
 

 
 Render an button submit:
 <s:submit type="button" value="%{'Submit the form'}"/>
 
 

THE FOLLOWING IS ONLY VALID WHEN AJAX IS CONFIGURED

• href
• errorText
• listenTopics
• notifyTopics
• executeScripts
• loadingText
• listenTopics
• handler
• formId
• formFilter
• targets
• showErrorTransportText
• targets
• indicator

'resultDivId' Deprecated. Use targets.

'targets' is a list of element ids whose content will be updated with the text returned from request.

'errorText' is the text that will be displayed when there is an error making the request.

'onLoadJS' Deprecated. Use 'notifyTopics'.

'preInvokeJS' Deprecated. Use 'notifyTopics'.

'executeScripts' if set to true will execute javascript sections in the returned text.

'loadingText' is the text that will be displayed on the 'targets' elements while making the request.

'handler' is the name of the function that will take care of making the AJAX request. Dojo's widget and dom node are passed as parameters).

'formId' is the id of the html form whose fields will be seralized and passed as parameters in the request.

'formFilter' is the name of a function which will be used to filter the fields that will be seralized. This function takes as a parameter the element and returns true if the element should be included.

'listenTopics' comma separated list of topics names, that will trigger a request 'indicator' element to be shown while the request executing 'showErrorTransportText': whether errors should be displayed (on 'targets')

'showLoadingText' show loading text on targets

'notifyTopics' comma separated list of topics names, that will be published. Three parameters are passed:

• data: html or json object when type='load' or type='error'
• type: 'before' before the request is made, 'load' when the request succeeds, or 'error' when it fails
• request: request javascript object, when type='load' or type='error'

Show the results in another div. If you want your results to be shown in a div, use the resultDivId where the id is the id of the div you want them shown in. This is an inner HTML approah. Your results get jammed into the div for you. Here is a sample of this approach:

 
 Remote form replacing another div:
 <div id='two' style="border: 1px solid yellow;">Initial content</div>
 <s:form
       id='theForm2'
       cssStyle="border: 1px solid green;"
       action='/AjaxRemoteForm.action'
       method='post'
       theme="ajax">

   <input type='text' name='data' value='Struts User' />
   <s:submit value="GO2" theme="ajax" resultDivId="two" />

 </s:form >
 
 

Since:

HDIV 2.0

Author:

Gorka Vicente

Field Summary

static java.lang.String

TEMPLATE

Fields inherited from class org.apache.struts2.components.Submit

afterLoading, beforeLoading, errorText, executeScripts, formFilter, formId, handler, href, indicator, listenTopics, loadingText, notifyTopics, showErrorTransportText, showLoadingText, src, targets

Fields inherited from class org.apache.struts2.components.FormButton

action, align, method, type

Fields inherited from class org.apache.struts2.components.UIBean

accesskey, cssClass, cssStyle, defaultTemplateDir, defaultUITheme, disabled, key, label, labelPosition, 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, value

Fields inherited from class org.apache.struts2.components.Component

actionMapper, COMPONENT_STACK, id, parameters, stack

Constructor Summary

SubmitHDIV(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

org.hdiv.dataComposer.IDataComposer	getDataComposer()
protected java.lang.String	getDefaultTemplate()

Methods inherited from class org.apache.struts2.components.Submit

end, evaluateExtraParams, evaluateParams, setAfterLoading, setBeforeLoading, setErrorText, setExecuteScripts, setFormFilter, setFormId, setHandler, setHref, setIndicator, setListenTopics, setLoadingText, setNotifyTopics, setShowErrorTransportText, setShowLoadingText, setSrc, setTargets, setTheme, supportsImageType

Methods inherited from class org.apache.struts2.components.FormButton

populateComponentHtmlId, setAction, setAlign, setMethod, setType

Methods inherited from class org.apache.struts2.components.UIBean

addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, escape, evaluateNameValue, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, setAccesskey, setCssClass, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setKey, setLabel, setLabelposition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, 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, getId, getParameters, getStack, popComponentStack, setActionMapper, setId, start, 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

Constructor Detail

SubmitHDIV

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

Method Detail

getDefaultTemplate

protected java.lang.String getDefaultTemplate()

Overrides:

getDefaultTemplate in class org.apache.struts2.components.Submit

getDataComposer

public org.hdiv.dataComposer.IDataComposer getDataComposer()

Returns:

Returns data composer from request