selectThumbRating (Liferay Faces Alloy View Description Language Documentation (VDLDoc))

Description:

SelectThumbRating is a UISelectOne component that renders a pair of thumb icons that a user can select to indicate their favor. The user can click on a thumb to select their favor and click on the same thumb a second time to de-select their favor. Since it extends HtmlSelectOneRadio, it accepts f:selectItem or f:selectItems as children.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/alloy-showcase/-/alloy-tag/alloy/selectthumbrating/general

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.selectthumbrating.SelectThumbRating`
Handler Class	None
Renderer Type	`com.liferay.faces.alloy.component.selectthumbrating.SelectThumbRatingRenderer`
Description	None

Attributes
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.
`clientKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The key name that can be used to reference the component on the client.
`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.
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the language code used in the element.
`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, 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.
`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.
`role`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the various WAI-ARIA roles that the element is used for.
`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.
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying where the element is located in the tabbing progression.
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the title of the element.
`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`.

alloy

Tag selectThumbRating