Package org.apache.tapestry5.corelib.components

Class LinkSubmit

  • All Implemented Interfaces:
    ClientElement
    @SupportsInformalParameters
@Events("selected by default, may be overridden")
@Import(module="t5/core/forms")
public class LinkSubmit
extends java.lang.Object
implements ClientElement
    Generates a client-side hyperlink that submits the enclosing form. If the link is clicked in the browser, the component will trigger an event (selected by default) , just like Submit.
    Component Parameters 
    NameTypeFlagsDefaultDefault Prefix
    contextObject[]Since 5.2.0 prop
    The list of values that will be made available to event handler method of this component when the form is submitted.
    deferboolean  prop
    If true (the default), then any notification sent by the component will be deferred until the end of the form submission (this is usually desirable). In general, this can be left as the default except when the LinkSubmit component is rendering inside a Loop, in which case defer should be bound to false (otherwise, the event context will always be the final value of the Loop).
    disabledboolean  prop
    If true, then no link (or accompanying JavaScript) is written (though the body still is).
    eventStringNot Null literal
    The name of the event that will be triggered if this component is the cause of the form submission. The default is "selected".
    modeorg.apache.tapestry5.corelib.SubmitModeNot Null literal
    Defines the mode, or client-side behavior, for the submit. The default is SubmitMode#NORMAL; clicking the button submits the form with validation. SubmitMode#CANCEL indicates the form should be submitted as a cancel, with no client-side validation. SubmitMode#UNCONDITIONAL bypasses client-side validation, but does not indicate that the form was cancelled.

    Component Events 
    NameDescription
    selectedby default, may be overridden

    • Constructor Summary

      Constructors 
      Constructor Description
      LinkSubmit()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClientId()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getClientId

        public java.lang.String getClientId()
        Specified by:
        getClientId in interface ClientElement
        Returns:
        a unique id for the element. This value will be unique for any given rendering of a page. This value is intended for use as the id attribute of the client-side element, and will be used with any DHTML/Ajax related JavaScript.