LinkSubmit

Creates a hyperlink that submits its enclosing form using a JavaScript function.

Pages incorporating a LinkSubmit component must also include a Body component.

See also: org.apache.tapestry.form.LinkSubmit , Form , ImageSubmit , Submit

Parameters

Name Type Direction Required Default Description
disabled boolean in no false Controls whether the link is produced. If disabled, the portion of the template the link surrounds is still rendered, but not the link itself.
selected Object out no This parameter is bound to a property that is updated when the submit button is clicked by the user. The property is updated to match the tag parameter.
tag Object in no Tag used with the selected parameter to indicate which Submit button on a form was clicked.
listener IActionListener in no An optional listener (typically specified as the name of a listener method), notified when the Submit is triggered.

When invoking listeners invoked within a For loop this listener should be used.

This parameter should not be used in the majority of cases as the listener is notified before all form data has been captured on the server. Only use this when you know you are going to redirect or do some other cancelling sort of action that isn't likely to alter form state. Use action as your preferred listener method parameter.

action IActionListener in no A listener that is notified if this component is triggered just before the form's listener, after all components enclosed by the Form have had a chance to update their properties.

If you are going to notify a listener, this is probably the parameter you want to bind to.

parameters Object in no Parameter(s) gathered at the time the link is triggered, supplied as listener parameters in the IRequestCycle available to the listener.

If the parameter is a Collection, it will be converted to an Object array (to match the IRequestCycle getListenerParameters() signature).

Allows deferred listeners (defer = true) access to any rewind state not conveniently placed using tag/selected (e.g. when there are multiple objects to select as might happen with a nested Foreach).

submitType String - [submit,cancel,refresh] yes submit Controls the type of submission that this component invokes. Using javascript this parameter will cause the invocation of the component to be recognized as a cancel/refresh/normal form submission depending on the value given. If you have a cancel="listener" or refresh="listener" parameter set on your Form they will be invoked accordingly.
updateComponents String[],Collection no In an asynchronous request, specifies which components should have their content rendered back to the client. These are expected to be unique component ids.

See: ResponseBuilder

json boolean no false Causes the request to be asynchronous and the response to be captured/rendered via the JSONResponseBuilder renderer.
async boolean no false Causes the request to be asynchronous and the response to be captured/rendered via the DojoAjaxResponseBuilder renderer.

Body: allowed

Informal parameters: allowed

Reserved parameters: name, href