|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
com.sun.rave.web.ui.component.SelectorBase
com.sun.rave.web.ui.component.Selector
com.sun.rave.web.ui.component.CheckboxGroupBase
public abstract class CheckboxGroupBase
Use the ui:checkboxGroup tag to display two or more
check boxes in a grid layout in the rendered HTML page. The
ui:checkboxGroup tag attributes that you
specify determine how the check boxes are displayed.
If the label attribute is specified a
com.sun.rave.web.ui.component.Label component
is rendered before the first checkbox and
identifies the checkbox group. The label component's
for attribute is
set to the id attribute of the first checkbox in
the rendered HTML page.
The check boxes are laid out in rows and columns in an HTML <table> element. The number of rows is defined by the length of the items array. The number of columns is defined by the columns attribute. The default layout is a single vertical column.
The items attribute must be a value binding expression.
The value binding expression assigned to the items
property evaluates to an Object array of
com.sun.rave.web.ui.model.Option instances. Each
instance represents one checkbox. The value property
of an Option instance represents the value of a
selected checkbox.
If the items array is empty nothing is rendered.
Zero or more check boxes may be selected.
The selected attribute must also be a value binding
expression that is evaluated to read and write an Object
array. When an array is read from the value binding expression,
it identifies the selected checkboxes. Each element in the array
is an Object value. Each Object value must
be equal to the value property of at least one Option
instance specified in the array obtained from the value binding
expression assigned to the items attribute.
The write method of the selected attribute's value
binding expression is called during the UPDATE_MODEL_PHASE
of the JSF lifecyle. If one or more checkboxes are selected
an Object array is passed as an argument to the
write method. This array contains the Object
values of the selected checkboxes.
A ui:checkboxGroup renders one
com.sun.rave.web.ui.component.Checkbox component for
each element in the items array.
See ui:checkbox for
details on the HTML elements and components rendered for a
checkbox.
The value of the name attribute of each
Checkbox component rendered is assigned the
clientId of the CheckboxGroup
component instance associated with this tag. The id
attribute of each Checkbox component rendered
is formed as follows, where cbgrpid is the id of the
CheckboxGroup instance and N is the nth
checkbox.
See ui:checkbox for details on how the id properties of the components that make up the checkbox are defined.
none.
<ui:checkboxGroup items="#{rbcbGrp.selections}"
label="#{rbcbGrp.cbGrpLabel}"
toolTip="cbgrp-tooltip"
disabled="false"
tabIndex="4"
selected="#{rbcbGrp.cbvalue}">
</ui:checkboxGroup>
This example creates a checkbox group with an identifying
label for the group before the first checkbox. The
data for the checkboxes is obtained from the value binding
expression #{rbcbGrp.selections}. rbcbGrp
is an application defined managed bean and provides the values for
other attributes such as selected to receive the
value of the selected checkboxes in the group.
Auto-generated component class. Do NOT modify; all changes will be lost!
| Field Summary |
|---|
| Fields inherited from class com.sun.rave.web.ui.component.Selector |
|---|
valueTypeEvaluator |
| Fields inherited from class javax.faces.component.UIInput |
|---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Constructor Summary | |
|---|---|
CheckboxGroupBase()
Construct a new CheckboxGroupBase. |
|
| Method Summary | |
|---|---|
int |
getColumns()
Defines how many columns may be used to lay out the check boxes. |
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
boolean |
isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setColumns(int columns)
Defines how many columns may be used to lay out the check boxes. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
| Methods inherited from class com.sun.rave.web.ui.component.Selector |
|---|
compareValues, getConvertedValue, getLabelLevel, getRendersChildren, getValueAsReadOnly, isMultiple, setMultiple, setSelected, toString |
| Methods inherited from class com.sun.rave.web.ui.component.SelectorBase |
|---|
getItems, getLabel, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getSelected, getStyle, getStyleClass, getTabIndex, getToolTip, getValueBinding, isDisabled, isReadOnly, setDisabled, setItems, setLabel, setLabelLevel, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setReadOnly, setStyle, setStyleClass, setTabIndex, setToolTip, setValueBinding |
| Methods inherited from class javax.faces.component.UIInput |
|---|
addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, getLocalValue, getValue, setConverter |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.sun.rave.web.ui.component.SelectorManager |
|---|
getClientId, getOnChange, getStyle, getStyleClass, getTabIndex, isDisabled, isReadOnly |
| Methods inherited from interface javax.faces.component.ValueHolder |
|---|
getConverter, getLocalValue, getValue, setConverter |
| Constructor Detail |
|---|
public CheckboxGroupBase()
Construct a new CheckboxGroupBase.
| Method Detail |
|---|
public java.lang.String getFamily()
Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate Renderer for this component instance.
getFamily in class SelectorBasepublic int getColumns()
Defines how many columns may be used to lay out the check boxes. The value must be greater than or equal to one. The default value is one. Invalid values are ignored and the value is set to one.
public void setColumns(int columns)
Defines how many columns may be used to lay out the check boxes. The value must be greater than or equal to one. The default value is one. Invalid values are ignored and the value is set to one.
getColumns()public boolean isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
isVisible in class SelectorBasepublic void setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
setVisible in class SelectorBaseisVisible()
public void restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component.
restoreState in interface javax.faces.component.StateHolderrestoreState in class SelectorBasepublic java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState in interface javax.faces.component.StateHoldersaveState in class SelectorBase
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||