Class KaptchaField

  • All Implemented Interfaces:
    ClientElement, Field

    public class KaptchaField
    extends AbstractField
    Field paired with a KaptchaImage to ensure that the user has provided the correct value. Renders a class attribute of "form-control", which can be extended via the class informal attribute.
    Component Parameters 
    NameTypeFlagsDefaultDefault Prefix
    clientIdString  literal
    Used to explicitly set the client-side id of the element for this component. Normally this is not bound (or null) and is used to generate a unique client-id based on the component's id. In some cases, when creating client-side behaviors, it is useful to explicitly set a unique id for an element using this parameter. Certain values, such as "submit", "method", "reset", etc., will cause client-side conflicts and are not allowed; using such will cause a runtime exception.
    ensureClientIdUniquebooleanSince 5.4 prop
    A rarely used option that indicates that the actual client id should start with the clientId parameter (if non-null) but should still pass that Id through to generate the final id. An example of this are the components used inside a org.apache.tapestry5.corelib.components.BeanEditor which will specify a clientId (based on the property name) but still require that it be unique. Defaults to false.
    imageorg.apache.tapestry5.kaptcha.components.KaptchaImageRequired component
    The image output for this field. The image will display a distorted text string. The user must decode the distorted text and enter the same value.
    visibleboolean symbol:tapestry.kaptcha-default-visibleprop
    Controls whether the field is rendered like a password field (false) or like a normal text field (true, the factory default).
    • Method Detail

      • processSubmission

        protected void processSubmission​(java.lang.String controlName)
        Description copied from class: AbstractField
        Method implemented by subclasses to actually do the work of processing the submission of the form. The element's controlName property will already have been set. This method is only invoked if the field is not disabled.
        Specified by:
        processSubmission in class AbstractField
        controlName - the control name of the rendered element (used to find the correct parameter in the request)