com.sun.webui.jsf.component.CheckboxGroup Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://woodstock.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://woodstock.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package com.sun.webui.jsf.component;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import javax.el.ValueExpression;
import javax.faces.component.NamingContainer;
import javax.faces.context.FacesContext;
/**
* The CheckboxGroup component is used to display a group of checkboxes
* in a grid layout.
*/
@Component(type = "com.sun.webui.jsf.CheckboxGroup", family = "com.sun.webui.jsf.CheckboxGroup",
displayName = "Checkbox Group", tagName = "checkboxGroup",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_checkbox_group",
propertiesHelpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_propsheets_checkbox_group_props")
public class CheckboxGroup extends Selector implements NamingContainer,
ComplexComponent {
/**
* Default constructor.
*/
public CheckboxGroup() {
super();
setMultiple(true);
setRendererType("com.sun.webui.jsf.CheckboxGroup");
}
/**
* Return the family for this component.
*/
@Override
public String getFamily() {
return "com.sun.webui.jsf.CheckboxGroup";
}
/**
* Implement this method so that it returns the DOM ID of the
* HTML element which should receive focus when the component
* receives focus, and to which a component label should apply.
* Usually, this is the first element that accepts input.
*
* @param context The FacesContext for the request
* @return The client id, also the JavaScript element id
* @deprecated
* @see #getLabeledElementId
* @see #getFocusElementId
*/
public String getPrimaryElementID(FacesContext context) {
return this.getClientId(context);
}
/**
* Returns the absolute ID of an HTML element suitable for use as
* the value of an HTML LABEL element's for attribute.
* If the ComplexComponent has sub-compoents, and one of
* the sub-components is the target of a label, if that sub-component
* is a ComplexComponent, then
* getLabeledElementId must called on the sub-component and
* the value returned. The value returned by this
* method call may or may not resolve to a component instance.
*
* @param context The FacesContext used for the request
* @return An abolute id suitable for the value of an HTML LABEL element's
* for attribute.
*/
public String getLabeledElementId(FacesContext context) {
// Return the first check box id. We don't support children
// yet and the Renderer creates the check boxes on the fly
// But we know what the id that the renderer creates
// for the first check button, hack, certainly.
//
return getFirstCbId(context);
}
/**
* Returns the id of an HTML element suitable to
* receive the focus.
* If the ComplexComponent has sub-compoents, and one of
* the sub-components is to reveive the focus, if that sub-component
* is a ComplexComponent, then
* getFocusElementId must called on the sub-component and
* the value returned. The value returned by this
* method call may or may not resolve to a component instance.
*
* @param context The FacesContext used for the request
*/
public String getFocusElementId(FacesContext context) {
// Return the first check box id. We don't support children
// yet and the Renderer creates the check boxes on the fly
// But we know what the id that the renderer creates
// for the first check box, hack, certainly.
//
return getFirstCbId(context);
}
private String getFirstCbId(FacesContext context) {
StringBuilder sb = new StringBuilder(getClientId(context)).append(String.valueOf(NamingContainer.SEPARATOR_CHAR)).append(getId()).append("_0"); //NOI18N
return sb.toString();
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Hide onBlur
@Property(name = "onBlur", isHidden = true, isAttribute = false)
@Override
public String getOnBlur() {
return super.getOnBlur();
}
// Hide onChange
@Property(name = "onChange", isHidden = true, isAttribute = false)
@Override
public String getOnChange() {
return super.getOnChange();
}
// Hide onFocus
@Property(name = "onFocus", isHidden = true, isAttribute = false)
@Override
public String getOnFocus() {
return super.getOnFocus();
}
// Hide onSelect
@Property(name = "onSelect", isHidden = true, isAttribute = false)
@Override
public String getOnSelect() {
return super.getOnSelect();
}
// Hide value
@Property(name = "value", isHidden = true, isAttribute = false)
@Override
public Object getValue() {
return super.getValue();
}
/**
* 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.
*/
@Property(name = "columns", displayName = "Columns", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor")
private int columns = Integer.MIN_VALUE;
private boolean columns_set = false;
/**
* 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 int getColumns() {
if (this.columns_set) {
return this.columns;
}
ValueExpression _vb = getValueExpression("columns");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return 1;
}
/**
* 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.
* @see #getColumns()
*/
public void setColumns(int columns) {
this.columns = columns;
this.columns_set = true;
}
/**
* 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.
*/
@Property(name = "visible", displayName = "Visible", category = "Behavior")
private boolean visible = false;
private boolean visible_set = false;
/**
* 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.
*/
@Override
public boolean isVisible() {
if (this.visible_set) {
return this.visible;
}
ValueExpression _vb = getValueExpression("visible");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* 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.
* @see #isVisible()
*/
@Override
public void setVisible(boolean visible) {
this.visible = visible;
this.visible_set = true;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.columns = ((Integer) _values[1]).intValue();
this.columns_set = ((Boolean) _values[2]).booleanValue();
this.visible = ((Boolean) _values[3]).booleanValue();
this.visible_set = ((Boolean) _values[4]).booleanValue();
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[5];
_values[0] = super.saveState(_context);
_values[1] = new Integer(this.columns);
_values[2] = this.columns_set ? Boolean.TRUE : Boolean.FALSE;
_values[3] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[4] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
return _values;
}
}