| Info | Value |
|---|---|
| Component Type | com.liferay.faces.portal.component.captcha.Captcha |
| Handler Class | None |
| Renderer Type | com.liferay.faces.portal.component.captcha.CaptchaRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An EL expression that binds the Java reference to this component in the component tree to a bean property. |
converter | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| The class name of the converter instance that is to be used by this component. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| This message or the result of the specified expression, will be used as the text of the converter message instead of any message that comes from the registered converter for this component. |
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A unique identifier for this component. |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean)
| When this flag is true, this component's value must be converted and validated (immediately) during the Apply Request Values phase, instead of (later) during the PROCESS_VALIDATIONS phase. |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized label for this component that is typically only rendered in a FacesMessage when validation fails. |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean)
| When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is true. |
required | false | javax.el.ValueExpression
(must evaluate to boolean)
| When this flag is true (the default), and a value has not been specified for this component, then the PROCESS_VALIDATIONS phase will fail and a FacesMessage will be added to the FacesContext for this component. Note: Even if the developer sets the value of this attribute to true, when running in Liferay Portal 7.0 (and above) the Captcha.isRequired() method can return false when an authenticated user has achieved a level of trust by correctly entering a maximum number of challenges. The maximum is defined by the captcha.max.challenges property in the portal-ext.properties file, which is '1' by default. When an authenticated user has gained the necessary level of trust, the captcha will no longer be rendered (or required) for the remainder of the session. Non-authenticated users will never be considered trustworthy, and will always be required enter a correct value for the captcha, provided that the value of the required property is true. For more information, see the default values in the "Captcha" section of Liferay Portal's portal.properties file and LPS-40401. |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component when required="true" and no value is selected by the user. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML passthrough attribute specifying the css style of the element. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| List of CSS class names (separated by spaces) that are to be rendered within the class attribute. |
url | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies a custom captcha image URL. If the value is empty (the default), then the image will be obtained from Liferay Portal's built-in captcha feature. |
validator | false | javax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent,
java.lang.Object))
| A method that is executed in the PROCESS_VALIDATIONS phase of the lifecycle. The method must be public, return void, and take three arguments of FacesContext, UIComponent, and Object. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| This message or the result of the specified expression, will be used as the text of the validation error message instead of any message that comes from the resulting validation error for this component. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| The value of this component, which is typically bound via EL to a model bean property. |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent))
| A method that is executed when the value of this component changes. The method must be public, return void, and take no arguments or one argument of ValueChangeEvent. |
Output generated by Vdldoc View Declaration Language Documentation Generator.