Java Doc for CheckboxRenderer.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » renderer » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The CheckboxRenderer renders a com.sun.rave.web.ui.component.Checkbox component.

Encoding

The CheckboxRenderer renders a Checkbox as:

• An INPUT element of type checkbox for each checkbox.
• An optional image. The component rendered for this feature is obtained from a call to getImageComponent() on the component being rendered.
• An optional label. The component rendered for this feature is obtained from a call to getLabelComponent() on the component being rendered.

The CSS selectors for the elements and components that comprise a checkbox are identified by java constants defined in the ThemeStyles class.

• CHECKBOX for the INPUT element
• CHECKBOX_DISABLED for the INPUT element of a disabled radio button
• CHECKBOX_LABEL for label component if a label is rendered
• CHECKBOX_LABEL_DISABLED for a label component of a disabled radio button, if a label is rendered
• CHECKBOX_IMAGE for an image component if an image is rendered
• CHECKBOX_IMAGE_DISABLED for an image component of a disabled radio button if an image is rendered.

For more details on the logic for actual renderering of HTML for a Checkbox component see the super class com.sun.rave.web.ui.renderer.RbCbRendererBase

Decoding

If the INPUT element representing a checkbox is selected on the the client, the submitted request will contain a request parameter whose name is the value of the name attribute of the selected HTML INPUT element. The value of the request parameter will be the value of the value attribute of the selected HTML INPUT element. If more than one checkbox INPUT element has the same value for the name attribute, then the value of the request parameter will be an array of those INPUT element values.

The component being decoded is selected if the component's isDisabled and isReadOnly methods return false and:

• a request parameter exists that is equal to its name property. If the name property is null, then a request parameter exists that is equal to its clientId property.

And

• the request parameter's value is an array that contains an element that is String.equal to the the component's selectedValue property, after conversion to a String, by calling ConversionUtilities.convertValueToString. If the component was encoded as a boolean control, then an element the request parameter's array value must be equal to the component's clientId property.

If selected, a String[1] array is assigned as the component's submitted value where the single array element is the String version of the selectedValue property or "true" if the component was encoded as a boolean control.
If not selected, a String[0] array is assigned as the component's submitted value or a String[1] array where the single array element is "false" if the component was encoded as a boolean control.

If the component's isDisabled or isReadOnly methods return true no submitted value is assigned to the component, and results in a null submitted value implying the component was not submitted, and the state of the component is unchanged.

Decode the Checkbox selection.

If the component's isDisabled and isReadOnly methods return false, If the value of the component's name property has been set, the value is used to match a request parameter. If it has not been set the component clientId is used to match a request parameter.

Decode the Checkbox selection.

If the component's isDisabled and isReadOnly methods return false, If the value of the component's name property has been set, the value is used to match a request parameter. If it has not been set the component clientId is used to match a request parameter. If a match is found, and the value of the of the request parameter matches the String value of the component's selectedValue property, the radio button is selected. The component's submitted value is assigned a String[1] array where the single array element is the matching parameter value.

If no matching request parameter or value is found, an instance of String[0] is assigned as the submitted value, meaning that this is a component was not selected.

If the component was encoded as a boolean control the value of the matching request attribute will be the component's clientId property if selected. If selected the submitted value is new String[] { "true" } and new String[] { "false" } if not selected.

It is the developer's responsibility to ensure the validity of the name property (the name attribute on the INPUT element) by ensuring that it is unique to the radio buttons for a given group within a form.