com.sun.webui.jsf.renderkit.html.SelectorGroupRenderer 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.renderkit.html;
import java.io.IOException;
import java.util.Map;
import java.util.Collection;
import javax.faces.component.UIInput;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import com.sun.webui.jsf.component.Label;
import com.sun.webui.jsf.component.Selector;
import com.sun.webui.jsf.component.RbCbSelector;
import com.sun.webui.jsf.model.Option;
import com.sun.webui.theme.Theme;
import com.sun.webui.jsf.util.ComponentUtilities;
import com.sun.webui.jsf.util.ConversionUtilities;
import com.sun.webui.jsf.util.RenderingUtilities;
/**
* The SelectorGroupRenderer is the abstract base class for
* {@link RadioButtonGroupRenderer} and
* {@link CheckboxGroupRenderer}. It provides
* common behavior for driving the
* {@link RowColumnRenderer} superclass.
* Its decode method provides decoding for both
* CheckboxGroup
* and RadioButtonGroup components. It decodes the value as a
* String[] for both components. For CheckboxGroup
* components this an array of possibly 0 or more elements. For
* the RadioButtonGroup component the value is decoded as a
* String[] of at least one element.
*/
//FIXME this should probably be a public or protected abstract class
abstract class SelectorGroupRenderer extends RowColumnRenderer {
/**
* The define constant indicating the style class
* for the top level TABLE element.
*/
protected final static int GRP = 0;
/**
* The define constant indicating the style class
* for the CSS table CAPTION (a CELL element).
*/
protected final static int GRP_CAPTION = 1;
/**
* The define constant indicating the style class
* for a disabled CSS table CAPTION (a LABEL) element.
*/
protected final static int GRP_LABEL = 2;
/**
* The define constant indicating the style class
* for a disabled CSS table CAPTION (a LABEL) element.
*/
protected final static int GRP_LABEL_DIS = 3;
/**
* The define constant indicating the style class
* for the even rows.
*/
protected final static int GRP_ROW_EVEN = 4;
/**
* The define constant indicating the style class
* for the odd rows.
*/
protected final static int GRP_ROW_ODD = 5;
/**
* The define constant indicating the style class
* for the even cells.
*/
protected final static int GRP_CELL_EVEN = 6;
/**
* The define constant indicating the style class
* for the odd cells.
*/
protected final static int GRP_CELL_ODD = 7;
/**
* The define constant indicating the style class
* for an INPUT element.
*/
protected final static int INPUT = 8;
/**
* The define constant indicating the style class
* for a disabled INPUT element.
*/
protected final static int INPUT_DIS = 9;
/**
* The define constant indicating the style class
* for the LABEL element.
*/
protected final static int LABEL = 10;
/**
* The define constant indicating the style class
* for a disabled LABEL element.
*/
protected final static int LABEL_DIS = 11;
/**
* The define constant indicating the style class
* for the IMG element.
*/
protected final static int IMAGE = 12;
/**
* The define constant indicating the style class
* for a disabled IMG element.
*/
protected final static int IMAGE_DIS = 13;
/**
* The define constant indicating the label level style class
* for a LABEL element.
*/
protected final static int LABEL_LVL1 = 14;
/**
* The define constant indicating the label level style class
* for a LABEL element.
*/
protected final static int LABEL_LVL2 = 15;
/**
* The define constant indicating the label level style class
* for a LABEL element.
*/
protected final static int LABEL_LVL3 = 16;
/**
* The define constant indicating the default label level style class
* for a LABEL element.
*/
protected final static int LABEL_LVL_DEF = 0;
private final static int LABEL_LVL = IMAGE_DIS;
/**
* Creates a new instance of SelectorGroupRenderer
*/
public SelectorGroupRenderer() {
super();
}
/**
* Return style constants for the controls in the group.
* The getStyles method is implemented by subclasses
* to return a String[] of style constants as
* defined in ThemeStyles
* in an order defined by the constants in this class.
*/
protected abstract String[] getStyles();
/**
* Implemented in the subclass to return the UIComponent for a
* control in the group.
*
* @param context FacesContext for the request we are processing.
* @param component The RadioButtonGroup component to be decoded.
* @param theme Theme for the request we are processing.
* @param id the new component's id.
* @param option the Option being rendered.
*/
protected abstract UIComponent getSelectorComponent(FacesContext context,
UIComponent component, Theme theme, String id, Option option);
/**
* Decode the RadioButtonGroup or
* CheckboxGroup selection.
* If the component clientId is found as a request parameter, which is
* rendered as the value of the name attribute of
* the INPUT elements of type radio or checkbox, the String[]
* value is assigned as the submitted value on the component.
*
* In the case of a CheckboxGroup component the array may
* have zero or more elements. In the case of RadioButtonGroup
* there is always only one element.
*
*
* If the component clientId is not found as a request parameter a
* String[0] is assigned as the submitted value,
* meaning that this is a CheckboxGroup component with no
* check boxes selected.
*
* @param context FacesContext for the request we are processing.
* @param component The RadioButtonGroup component to be decoded.
*/
@Override
public void decode(FacesContext context, UIComponent component) {
if (context == null || component == null) {
throw new NullPointerException();
}
if (isDisabled(component) || isReadOnly(component)) {
return;
}
setSubmittedValues(context, component);
}
private void setSubmittedValues(FacesContext context,
UIComponent component) {
String clientId = component.getClientId(context);
Map requestParameterValuesMap = context.getExternalContext().
getRequestParameterValuesMap();
// If the clientId is found some controls are checked
//
if (requestParameterValuesMap.containsKey(clientId)) {
String[] newValues = (String[]) requestParameterValuesMap.get(clientId);
((UIInput) component).setSubmittedValue(newValues);
return;
}
// Return if there are no disabledCheckedValues and there
// were no controls checked
//
((UIInput) component).setSubmittedValue(new String[0]);
return;
}
/**
* Render the child components of this UIComponent, following the rules
* described for encodeBegin() to acquire the appropriate value to be
* rendered. This method will only be called if the rendersChildren property
* of this component is true.
*
* @param context FacesContext for the request we are processing.
* @param component UIComponent to be decoded.
*/
@Override
public void encodeChildren(FacesContext context, UIComponent component)
throws IOException {
}
/**
* Called from the renderEnd method of the subclass to begin
* rendering the component.
*
* @param context FacesContext for the request we are processing.
* @param component UIComponent to be decoded.
* @param writer ResponseWriter to which the HTML will
* be output
* @param columns the number of columns to use when rendering the controls
*/
protected void renderSelectorGroup(FacesContext context,
UIComponent component, Theme theme,
ResponseWriter writer, int columns)
throws IOException {
// If there are more items than columns, render additional rows.
//
Selector selector = (Selector) component;
// See if we are rendering null for nothing selected
//
Object selected = selector.getSelected();
// If the submittedValue is null record the rendered value
// If the submittedValue is not null then it contains the
// String values of the selected controls.
// If the submittedValue is not null but zero in length
// then nothing is selected. Assume that the component still
// has the appropriate rendered state.
//
if (selector.getSubmittedValue() == null) {
ConversionUtilities.setRenderedValue(component, selected);
}
// If there aren't any items don't render anything
//
Option[] items = getItems((Selector) component);
if (items == null) {
return;
}
int length = items.length;
if (length == 0) {
return;
}
columns = columns <= 0 ? 1 : (columns > length ? length : columns);
int rows = (length + (columns - 1)) / columns;
// Render the table layout
renderRowColumnLayout(context, component, theme,
writer, rows, columns);
}
// Should be in component
//
protected Option[] getItems(Selector selector) {
Object items = selector.getItems();
if (items == null) {
return null;
} else if (items instanceof Option[]) {
return (Option[]) items;
} else if (items instanceof Map) {
int size = ((Map) items).size();
return (Option[]) ((Map) items).values().toArray(new Option[size]);
} else if (items instanceof Collection) {
int size = ((Collection) items).size();
return (Option[]) ((Collection) items).toArray(new Option[size]);
} else {
throw new IllegalArgumentException(
"Selector.items is not Option[], Map, or Collection");
}
}
protected void renderCellContent(FacesContext context,
UIComponent component,
Theme theme,
ResponseWriter writer,
int itemN) throws IOException {
Option[] items = getItems((Selector) component);
if (itemN >= items.length) {
renderEmptyCell(context, component, theme, writer);
return;
}
String id = component.getId().concat("_") + itemN; //NOI18N
UIComponent content = getSelectorComponent(context, component,
theme, id, items[itemN]);
RenderingUtilities.renderComponent(content, context);
}
/**
* Called by the RowColumnRenderer superclass when the
* group label should be rendered.
*
* @param context FacesContext for the request we are processing.
* @param component UIComponent to be decoded.
* @param theme Theme for the request we are processing.
* @param writer ResponseWriter to which the HTML will
* be output
*/
protected void renderCaption(FacesContext context,
UIComponent component,
Theme theme, ResponseWriter writer)
throws IOException {
UIComponent captionComponent = getCaptionComponent(context,
component, theme, component.getId().concat("_caption")); //NOI18N
if (captionComponent != null) {
RenderingUtilities.renderComponent(captionComponent, context);
}
}
private UIComponent getCaptionComponent(FacesContext context,
UIComponent component, Theme theme,
String captionId) throws IOException {
// Check if the page author has defined a label facet
//
// What if the component is readonly ? Do we need to modify
// the facet to be readonly, disabled, or required ?
// What about styles, etc.
//
UIComponent labelComponent = component.getFacet("label"); //NOI18N
if (labelComponent != null) {
return labelComponent;
}
// If we find a label, define a label component
//
String attrvalue =
(String) component.getAttributes().get("label"); //NOI18N
if (attrvalue == null || attrvalue.length() <= 0) {
return null;
}
// This code should be in the component.
// But it is more complicated than that since the argument is
// "UIComponent" and not RadioButtonGroup or CheckboxGroup.
// Too much needs to be done so leave this way for now until
// we fix all renderers with similar problems.
//
Label label = (Label) ComponentUtilities.getPrivateFacet(component,
"label", true); //NOI18N
if (label == null) {
label = new Label();
label.setId(ComponentUtilities.createPrivateFacetId(
component, "label")); //NOI18N
ComponentUtilities.putPrivateFacet(component, "label", //NOI18N
label);
}
label.setText(attrvalue);
// Set the for attribute. This will eventually resolve to the
// the first control.
//
label.setFor(component.getClientId(context));
// Give the group's tooltip to the group label
//
attrvalue =
(String) component.getAttributes().get("toolTip"); //NOI18N
if (attrvalue != null) {
label.setToolTip(attrvalue);
}
Integer lblLvl = (Integer) component.getAttributes().get("labelLevel"); //NOI18N
// Need to synch up defaults
//
if (lblLvl == null) {
lblLvl = new Integer(2);
}
label.setLabelLevel(lblLvl == null ? 2 : lblLvl.intValue());
int styleCode = GRP_LABEL;
Boolean disabled =
(Boolean) component.getAttributes().get("disabled"); //NOI18N
if (disabled != null && disabled.booleanValue() == true) {
styleCode = GRP_LABEL_DIS;
}
String captionStyle = getStyle(theme, styleCode);
if (captionStyle != null) {
label.setStyleClass(captionStyle);
}
return label;
}
/**
* Called from the renderCellContent method implemented
* in the sublclass when there are no more controls to render.
*
* @param context FacesContext for the request we are processing.
* @param component UIComponent to be decoded.
* @param theme Theme for the request we are processing.
* @param writer ResponseWriter to which the HTML will
* be output
*/
protected void renderEmptyCell(FacesContext context,
UIComponent component, Theme theme,
ResponseWriter writer) throws IOException {
/*
writer.writeText(" ", null); //NOI18N
*/
}
// Structural styles
//
private int[] rowcolstyle = {
GRP, GRP_CAPTION, GRP_ROW_EVEN, GRP_ROW_ODD,
GRP_CELL_EVEN, GRP_CELL_ODD
};
/**
* Pass on the style request from the
* {@link com.sun.webui.jsf.renderkit.html.RowColumnRenderer} to
* the SelectorGroupRenderer subclass.
*
* @param theme Theme for the request we are processing.
* @param styleCode the desired style class constant
*/
protected final String getRowColumnStyle(Theme theme, int styleCode) {
return getStyle(theme, rowcolstyle[styleCode]);
}
/**
* Return the style class name for the structural element indicated
* by styleCode
*
* @param styleCode identifies the style class for the element about
* to be rendered.
*/
private String getStyle(Theme theme, int styleCode) {
String style = null;
try {
style = theme.getStyleClass(getStyles()[styleCode]);
} catch (Exception e) {
// Don't care
}
return style;
}
/**
* Return the style class name and level for the structural element
* indicated by styleCode
*
* @param styleCode identifies the style class for the element about
* to be rendered.
* @param styleLevelCode identifies the style class level for the
* element about to be rendered.
*/
protected String getStyle(Theme theme,
int styleCode, int styleLevelCode) {
String style = getStyle(theme, styleCode);
if (style == null) {
return null;
}
StringBuffer styleBuf = new StringBuffer(style);
String styleLevel = null;
if (styleLevelCode != LABEL_LVL_DEF) {
styleLevel = getStyle(theme, styleLevelCode);
}
// No style code for the desired one, get the default
//
if (styleLevel != null) {
if (styleBuf.length() != 0) {
styleBuf.append(" "); //NOI18N
}
styleBuf.append(styleLevel);
} else {
style = null;
switch (styleCode) {
case GRP_CAPTION:
style = getStyle(theme, LABEL_LVL2);
break;
case LABEL:
style = getStyle(theme, LABEL_LVL3);
break;
}
if (style != null) {
if (styleBuf.length() != 0) {
styleBuf.append(" "); //NOI18N
}
styleBuf.append(style);
}
}
return styleBuf.toString();
}
// mbohm 6300361,6300362
// Transfer event attributes from a radiobuttongroup/checkboxgroup to a
// radiobutton/checkbox.
protected void transferEventAttributes(Selector group, RbCbSelector rbcb) {
Map groupAttributes = group.getAttributes();
Map rbcbAttributes = rbcb.getAttributes();
final String[] eventAttributeNames =
AbstractRenderer.EVENTS_ATTRIBUTES;
for (int i = 0; i < eventAttributeNames.length; i++) {
Object eventAttributeValue =
groupAttributes.get(eventAttributeNames[i]);
if (eventAttributeValue != null) {
rbcbAttributes.put(eventAttributeNames[i],
eventAttributeValue);
}
}
}
}