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

Fields

Modifier and Type	Field and Description
protected String	button
protected String	buttonIcon
protected String	buttonIconSecondary
protected String	buttonText
protected String	clearForm
static String	COMPONENT_NAME
protected String	formFilter
protected String	iframe
static String	JQUERYACTION
protected String	onClickTopics
protected String	openDialog
protected String	openDialogTitle
protected String	parentTheme
protected String	replaceTarget
protected String	resetForm
protected String	src
static String	TEMPLATE
static String	TEMPLATE_CLOSE
protected String	type
protected String	validate
protected 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

onAfterValidationTopics, 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, standardAttributesMap, 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

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	end(Writer writer, String body) Overrides to be able to render body in a template rather than always before the template
void	evaluateExtraParams()
void	evaluateParams()
String	getComponentName()
String	getDefaultOpenTemplate()
protected String	getDefaultTemplate()
String	getTheme()
void	setButton(String button)
void	setButtonIcon(String buttonIcon)
void	setButtonIconSecondary(String buttonIconSecondary)
void	setButtonText(String buttonText)
void	setClearForm(String clearForm)
void	setFormFilter(String formFilter)
void	setIframe(String iframe)
void	setOnClickTopics(String onClickTopics)
void	setOpenDialog(String openDialog)
void	setOpenDialogTitle(String openDialogTitle)
void	setParentTheme(String parentTheme)
void	setReplaceTarget(String replaceTarget)
void	setResetForm(String resetForm)
void	setSrc(String src)
void	setTheme(String theme)
void	setType(String type)
void	setValidate(String validate)
void	setValidateFunction(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

setOnAfterValidationTopics, 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, copyParams, enableAncestorFormCustomOnsubmit, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, getId, getStandardAttributes, 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, completeExpressionIfAltSyntax, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findStringIfAltSyntax, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, setThrowExceptionsOnELFailure, setUrlHelper, 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 String TEMPLATE

See Also:

Constant Field Values

TEMPLATE_CLOSE

public static final String TEMPLATE_CLOSE

See Also:

Constant Field Values

JQUERYACTION

public static final String JQUERYACTION

See Also:

Constant Field Values

COMPONENT_NAME

public static final String COMPONENT_NAME

src

protected String src

type

protected String type

clearForm

protected String clearForm

resetForm

protected String resetForm

iframe

protected String iframe

onClickTopics

protected String onClickTopics

openDialog

protected String openDialog

openDialogTitle

protected String openDialogTitle

parentTheme

protected String parentTheme

button

protected String button

buttonIcon

protected String buttonIcon

buttonIconSecondary

protected String buttonIconSecondary

buttonText

protected String buttonText

validate

protected String validate

validateFunction

protected String validateFunction

formFilter

protected String formFilter

replaceTarget

protected 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 String getDefaultOpenTemplate()

Specified by:

getDefaultOpenTemplate in class org.apache.struts2.components.ClosingUIBean

getDefaultTemplate

protected String getDefaultTemplate()

Specified by:

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

getComponentName

public 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(String theme)

Overrides:

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

getTheme

public 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(Writer writer,
          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(String type)

setSrc

public void setSrc(String src)

setClearForm

public void setClearForm(String clearForm)

setResetForm

public void setResetForm(String resetForm)

setIframe

public void setIframe(String iframe)

setOnClickTopics

public void setOnClickTopics(String onClickTopics)

setOpenDialog

public void setOpenDialog(String openDialog)

setOpenDialogTitle

public void setOpenDialogTitle(String openDialogTitle)

setParentTheme

public void setParentTheme(String parentTheme)

setButton

public void setButton(String button)

Specified by:

setButton in interface ButtonBean

setButtonIcon

public void setButtonIcon(String buttonIcon)

Specified by:

setButtonIcon in interface ButtonBean

setButtonIconSecondary

public void setButtonIconSecondary(String buttonIconSecondary)

Specified by:

setButtonIconSecondary in interface ButtonBean

setButtonText

public void setButtonText(String buttonText)

Specified by:

setButtonText in interface ButtonBean

setValidateFunction

public void setValidateFunction(String validateFunction)

setValidate

public void setValidate(String validate)

setFormFilter

public void setFormFilter(String formFilter)

setReplaceTarget

public void setReplaceTarget(String replaceTarget)