com.jgeppert.struts2.jquery.components
Class Submit

java.lang.Object
  org.apache.struts2.components.Component
      org.apache.struts2.components.UIBean
          org.apache.struts2.components.ClosingUIBean
              com.jgeppert.struts2.jquery.components.AbstractTopicsBean
                  com.jgeppert.struts2.jquery.components.AbstractRemoteBean
                      com.jgeppert.struts2.jquery.components.Submit

All Implemented Interfaces:

ButtonBean

public class Submit
extends AbstractRemoteBean
implements ButtonBean

Renders a submit button that can submit a form asynchronously. 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

 <sj:submit value="%{'Submit'}" />
 

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

 <sj:submit type="button" value="%{'Submit'}" label="Submit the form"/>
 

 <div id="div1">Div 1</div> 
 <s:url id="ajaxTest" value="/AjaxTest.action"/>
 <sj:submit id="link1" href="%{ajaxTest}" target="div1" />
 

 <s:form id="form" action="AjaxTest">
 <input type="textbox" name="data"> <sj:submit /> 
 </s:form>
 

 <s:form id="form" action="AjaxTest">
 <input type="textbox" name="data"> 
 </s:form>
 
 <sj:submit formId="form" />
 

 <script type="text/javascript">
 function before(event){ alert('before request'); }; 
 function complete(event){ alert('after request'); }; 
 </script>
 
 <sj:submit beforeSend="before()" complete="complete()" />
 

 <sj:submit value"AJAX Submit with effect"
 effect="highlight" effectOptions="color : '#222222'"
 effectDuration="3600"> href="%{#ajaxTest}" />
 

Author:

Johannes Geppert

Field Summary

protected java.lang.String	button
protected java.lang.String	buttonIcon
protected java.lang.String	buttonIconSecondary
protected java.lang.String	clearForm
static java.lang.String	COMPONENT_NAME
protected java.lang.String	formFilter
protected java.lang.String	iframe
static java.lang.String	JQUERYACTION
protected java.lang.String	onClickTopics
protected java.lang.String	openDialog
protected java.lang.String	parentTheme
protected java.lang.String	replaceTarget
protected java.lang.String	resetForm
protected java.lang.String	src
static java.lang.String	TEMPLATE
static java.lang.String	TEMPLATE_CLOSE
protected java.lang.String	type
protected java.lang.String	validate
protected java.lang.String	validateFunction

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractRemoteBean

dataType, effect, effectDuration, effectMode, effectOptions, errorElementId, errorText, formIds, href, indicator, listenTopics, loadingText, onEffectCompleteTopics, requestType, targets, timeout

Fields inherited from class com.jgeppert.struts2.jquery.components.AbstractTopicsBean

onAlwaysTopics, onBeforeTopics, onBlurTopics, onChangeTopics, onCompleteTopics, onDisableTopics, onEnableTopics, onErrorTopics, onFocusTopics, onSuccessTopics

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, throwExceptionOnELFailure

Constructor Summary

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

Method Summary

boolean	end(java.io.Writer writer, java.lang.String body) Overrides to be able to render body in a template rather than always before the template
void	evaluateExtraParams()
void	evaluateParams()
java.lang.String	getComponentName()
java.lang.String	getDefaultOpenTemplate()
protected java.lang.String	getDefaultTemplate()
java.lang.String	getTheme()
void	setButton(java.lang.String button)
void	setButtonIcon(java.lang.String buttonIcon)
void	setButtonIconSecondary(java.lang.String buttonIconSecondary)
void	setClearForm(java.lang.String clearForm)
void	setFormFilter(java.lang.String formFilter)
void	setIframe(java.lang.String iframe)
void	setOnClickTopics(java.lang.String onClickTopics)
void	setOpenDialog(java.lang.String openDialog)
void	setParentTheme(java.lang.String parentTheme)
void	setReplaceTarget(java.lang.String replaceTarget)
void	setResetForm(java.lang.String resetForm)
void	setSrc(java.lang.String src)
void	setTheme(java.lang.String theme)
void	setType(java.lang.String type)
void	setValidate(java.lang.String validate)
void	setValidateFunction(java.lang.String validateFunction)
protected boolean	supportsImageType() Indicate whether the concrete button supports the type "image".

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractRemoteBean

setDataType, setEffect, setEffectDuration, setEffectMode, setEffectOptions, setErrorElementId, setErrorText, setFormIds, setHref, setIndicator, setListenTopics, setLoadingText, setOnEffectCompleteTopics, setRequestType, setTargets, setTimeout

Methods inherited from class com.jgeppert.struts2.jquery.components.AbstractTopicsBean

setOnAlwaysTopics, setOnBeforeTopics, setOnBlurTopics, setOnChangeTopics, setOnCompleteTopics, setOnDisableTopics, setOnEnableTopics, setOnErrorTopics, setOnFocusTopics, setOnSuccessTopics

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

setOpenTemplate, start

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

addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, getId, getTemplate, getTemplateDir, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setId, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setName, 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, altSyntax, completeExpressionIfAltSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findStringIfAltSyntax, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, setThrowExceptionsOnELFailure, stripExpressionIfAltSyntax, stripExpressionIfAltSyntax, 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

JQUERYACTION

public static final java.lang.String JQUERYACTION

See Also:

Constant Field Values

COMPONENT_NAME

public static final java.lang.String COMPONENT_NAME

src

protected java.lang.String src

type

protected java.lang.String type

clearForm

protected java.lang.String clearForm

resetForm

protected java.lang.String resetForm

iframe

protected java.lang.String iframe

onClickTopics

protected java.lang.String onClickTopics

openDialog

protected java.lang.String openDialog

parentTheme

protected java.lang.String parentTheme

button

protected java.lang.String button

buttonIcon

protected java.lang.String buttonIcon

buttonIconSecondary

protected java.lang.String buttonIconSecondary

validate

protected java.lang.String validate

validateFunction

protected java.lang.String validateFunction

formFilter

protected java.lang.String formFilter

replaceTarget

protected java.lang.String replaceTarget

Constructor Detail

Submit

public Submit(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

getComponentName

public java.lang.String getComponentName()

evaluateParams

public void evaluateParams()

Overrides:

evaluateParams in class org.apache.struts2.components.UIBean

evaluateExtraParams

public void evaluateExtraParams()

Overrides:

evaluateExtraParams in class AbstractRemoteBean

setTheme

public void setTheme(java.lang.String theme)

Overrides:

setTheme in class org.apache.struts2.components.UIBean

getTheme

public java.lang.String getTheme()

Overrides:

getTheme in class org.apache.struts2.components.UIBean

supportsImageType

protected boolean supportsImageType()

Indicate whether the concrete button supports the type "image".

Returns:

true to indicate type image is supported.

end

public boolean end(java.io.Writer writer,
                   java.lang.String body)

Overrides to be able to render body in a template rather than always before the template

Overrides:

end in class org.apache.struts2.components.UIBean

setType

public void setType(java.lang.String type)

setSrc

public void setSrc(java.lang.String src)

setClearForm

public void setClearForm(java.lang.String clearForm)

setResetForm

public void setResetForm(java.lang.String resetForm)

setIframe

public void setIframe(java.lang.String iframe)

setOnClickTopics

public void setOnClickTopics(java.lang.String onClickTopics)

setOpenDialog

public void setOpenDialog(java.lang.String openDialog)

setParentTheme

public void setParentTheme(java.lang.String parentTheme)

setButton

public void setButton(java.lang.String button)

Specified by:

setButton in interface ButtonBean

setButtonIcon

public void setButtonIcon(java.lang.String buttonIcon)

Specified by:

setButtonIcon in interface ButtonBean

setButtonIconSecondary

public void setButtonIconSecondary(java.lang.String buttonIconSecondary)

Specified by:

setButtonIconSecondary in interface ButtonBean

setValidateFunction

public void setValidateFunction(java.lang.String validateFunction)

setValidate

public void setValidate(java.lang.String validate)

setFormFilter

public void setFormFilter(java.lang.String formFilter)

setReplaceTarget

public void setReplaceTarget(java.lang.String replaceTarget)