Javadoc hosting sponsored by DD Poker and Donohoe Digital LLC.

org.apache.wicket.markup.html.form
Class SubmitLink<T>

java.lang.Object
  extended by org.apache.wicket.Component<T>
      extended by org.apache.wicket.MarkupContainer<T>
          extended by org.apache.wicket.markup.html.WebMarkupContainer<T>
              extended by org.apache.wicket.markup.html.link.AbstractLink<T>
                  extended by org.apache.wicket.markup.html.form.AbstractSubmitLink<T>
                      extended by org.apache.wicket.markup.html.form.SubmitLink<T>
Type Parameters:
T - The model object type
All Implemented Interfaces:
java.io.Serializable, IClusterable, IConverterLocator<T>, IFormSubmittingComponent

public class SubmitLink<T>
extends AbstractSubmitLink<T>

A link which can be used exactly like a Button to submit a Form. The href of the link will use JavaScript to submit the form.

You can use this class 2 ways. First with the constructor without a Form object then this Link must be inside a Form so that it knows what form to submit to. Second way is to use the Form constructor then that form will be used to submit to.

 Form f = new Form("linkForm", new CompoundPropertyModel(mod));
     f.add(new TextField("value1"));
     f.add(new SubmitLink("link1") {
         protected void onSubmit() {
             System.out.println("Link1 was clicked, value1 is: "
                                 + mod.getValue1());
         };
      });
      add(new SubmitLink("link2",f) {
          protected void onSubmit() {
              System.out.println("Link2 was clicked, value1 is: "
                                 + mod.getValue1());
           };
      });
          
      <form wicket:id="linkForm" >
          <input wicket:id="value1" type="text" size="30"/>
          <a wicket:id="link1">Press link1 to submit</a>
          <input type="submit" value="Send"/>
      </form>
      <a wicket:id="link2">Press link 2 to submit</a>
 

If this link is not placed in a form or given a form to cooperate with, it will fall back to a normal link behavior, meaning that onSubmit() will be called without any other consequences.

Author:
chris, jcompagner, Igor Vaynberg (ivaynberg), Eelco Hillenius
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.wicket.Component
Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component<?>>, Component.VisibilityChange
 
Field Summary
 
Fields inherited from class org.apache.wicket.Component
ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
 
Constructor Summary
SubmitLink(java.lang.String id)
          With this constructor the SubmitLink must be inside a Form.
SubmitLink(java.lang.String id, Form<?> form)
          With this constructor the SubmitLink will submit the Form that is given when the link is clicked on.
SubmitLink(java.lang.String id, IModel<T> model)
          With this constructor the SubmitLink must be inside a Form.
SubmitLink(java.lang.String id, IModel<T> model, Form<?> form)
          With this constructor the SubmitLink will submit the Form that is given when the link is clicked on.
 
Method Summary
protected  java.lang.String getTriggerJavaScript()
          The javascript which triggers this link.
protected  void onComponentTag(ComponentTag tag)
          Processes the component tag.
 void onLinkClicked()
          This method is here as a means to fall back on normal link behavior when this link is not nested in a form.
 void onSubmit()
          Override this method to provide special submit handling in a multi-button form.
protected  boolean shouldInvokeJavascriptFormOnsubmit()
          Controls whether or not clicking on this link will invoke form's javascript onsubmit handler.
 
Methods inherited from class org.apache.wicket.markup.html.form.AbstractSubmitLink
getDefaultFormProcessing, getForm, getInputName, setDefaultFormProcessing
 
Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink
disableLink, getAfterDisabledLink, getBeforeDisabledLink, isLinkEnabled, onBeforeRender, onComponentTagBody, setAfterDisabledLink, setBeforeDisabledLink
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeginRequest, onDetach, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubmitLink

public SubmitLink(java.lang.String id)
With this constructor the SubmitLink must be inside a Form.

Parameters:
id - The id of the submitlink.

SubmitLink

public SubmitLink(java.lang.String id,
                  Form<?> form)
With this constructor the SubmitLink will submit the Form that is given when the link is clicked on. The SubmitLink doesn't have to be in inside the Form. But currently if it is outside the Form and the SubmitLink will be rendered first. Then the Form will have a generated javascript/css id. The markup javascript/css id that can exist will be overridden.

Parameters:
id - The id of the submitlink.
form - The form which this submitlink must submit.

SubmitLink

public SubmitLink(java.lang.String id,
                  IModel<T> model)
With this constructor the SubmitLink must be inside a Form.

Parameters:
id - The id of the submitlink.
model - The model for this submitlink, It won't be used by the submit link itself, but it can be used for keeping state

SubmitLink

public SubmitLink(java.lang.String id,
                  IModel<T> model,
                  Form<?> form)
With this constructor the SubmitLink will submit the Form that is given when the link is clicked on. The SubmitLink doesn't have to be in inside the Form. But currently if it is outside the Form and the SubmitLink will be rendered first. Then the Form will have a generated javascript/css id. The markup javascript/css id that can exist will be overridden.

Parameters:
id - The id of the submitlink.
model - The model for this submitlink, It won't be used by the submit link itself, but it can be used for keeping state
form - The form which this submitlink must submit.
Method Detail

onLinkClicked

public final void onLinkClicked()
This method is here as a means to fall back on normal link behavior when this link is not nested in a form. Not intended to be called by clients directly.

See Also:
ILinkListener.onLinkClicked()

onComponentTag

protected void onComponentTag(ComponentTag tag)
Description copied from class: Component
Processes the component tag.

Overrides:
onComponentTag in class Component<T>
Parameters:
tag - Tag to modify
See Also:
Component.onComponentTag(org.apache.wicket.markup.ComponentTag)

shouldInvokeJavascriptFormOnsubmit

protected boolean shouldInvokeJavascriptFormOnsubmit()
Controls whether or not clicking on this link will invoke form's javascript onsubmit handler. True by default.

Returns:
true if form's javascript onsubmit handler should be invoked, false otherwise

getTriggerJavaScript

protected final java.lang.String getTriggerJavaScript()
The javascript which triggers this link.

Returns:
The javascript

onSubmit

public void onSubmit()
Description copied from interface: IFormSubmittingComponent
Override this method to provide special submit handling in a multi-button form. It is called whenever the user clicks this particular button.

See Also:
IFormSubmittingComponent.onSubmit()


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