/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.richfaces.renderkit;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.faces.application.FacesMessage;
import javax.faces.application.ResourceDependencies;
import javax.faces.application.ResourceDependency;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.PartialResponseWriter;
import javax.faces.context.PartialViewContext;
import javax.faces.context.ResponseWriter;
import org.ajax4jsf.javascript.JSReference;
import org.ajax4jsf.javascript.ScriptString;
import org.richfaces.application.FacesMessages;
import org.richfaces.application.MessageFactory;
import org.richfaces.component.AbstractSelect;
import org.richfaces.component.AbstractSelectComponent;
import org.richfaces.component.AutocompleteMode;
import org.richfaces.component.MetaComponentResolver;
import org.richfaces.component.attribute.AutocompleteProps;
import org.richfaces.component.util.InputUtils;
import org.richfaces.context.ExtendedPartialViewContext;
import org.richfaces.javascript.JavaScriptService;
import org.richfaces.renderkit.util.HtmlDimensions;
import org.richfaces.application.ServiceTracker;
import org.richfaces.validator.SelectLabelValueValidator;
import org.richfaces.validator.csv.AddCSVMessageScript;
/**
* @author abelevich
* @author <a href="http://community.jboss.org/people/bleathem">Brian Leathem</a>
*/
@ResourceDependencies({ @ResourceDependency(library = "javax.faces", name = "jsf.js"),
@ResourceDependency(library = "org.richfaces", name = "jquery.js"),
@ResourceDependency(library = "org.richfaces", name = "richfaces.js"),
@ResourceDependency(library = "org.richfaces", name = "richfaces-queue.reslib"),
@ResourceDependency(library = "org.richfaces", name = "richfaces-base-component.js"),
@ResourceDependency(library = "org.richfaces", name = "jquery.position.js"), @ResourceDependency(library = "org.richfaces", name = "richfaces-event.js"),
@ResourceDependency(library = "org.richfaces", name = "richfaces-utils.js"), @ResourceDependency(library = "org.richfaces", name = "richfaces-selection.js"),
@ResourceDependency(library = "org.richfaces", name = "inputBase.js"),
@ResourceDependency(library = "org.richfaces", name = "popup.js"),
@ResourceDependency(library = "org.richfaces", name = "list.js"),
@ResourceDependency(library = "org.richfaces", name = "popupList.js"),
@ResourceDependency(library = "org.richfaces", name = "select.js"),
@ResourceDependency(library = "org.richfaces", name = "select.ecss") })
public class SelectRendererBase extends InputRendererBase implements MetaComponentRenderer {
public static final String ITEM_CSS = "rf-sel-opt";
public JSReference getClientFilterFunction(UIComponent component) {
AbstractSelect select = (AbstractSelect) component;
String clientFilter = (String) select.getAttributes().get("clientFilterFunction");
if (clientFilter != null && clientFilter.length() != 0) {
return new JSReference(clientFilter);
}
return null;
}
@Override
protected void doDecode(FacesContext context, UIComponent component) {
AbstractSelect select = (AbstractSelect) component;
if (InputUtils.isDisabled(select)) {
return;
}
super.doDecode(context, component);
Map<String, String> requestParameters = context.getExternalContext().getRequestParameterMap();
if (requestParameters.get(component.getClientId(context) + ".ajax") != null) {
PartialViewContext pvc = context.getPartialViewContext();
pvc.getRenderIds().add(
component.getClientId(context) + MetaComponentResolver.META_COMPONENT_SEPARATOR_CHAR
+ AbstractSelect.ITEMS_META_COMPONENT_ID);
context.renderResponse();
}
}
public void encodeMetaComponent(FacesContext context, UIComponent component, String metaComponentId) throws IOException {
if (AbstractSelect.ITEMS_META_COMPONENT_ID.equals(metaComponentId)) {
List<ClientSelectItem> clientSelectItems = getConvertedSelectItems(context, component);
PartialResponseWriter partialWriter = context.getPartialViewContext().getPartialResponseWriter();
String itemsClientId = component.getClientId() + "Items";
partialWriter.startUpdate(itemsClientId);
ResponseWriter responseWriter = context.getResponseWriter();
responseWriter.startElement(HtmlConstants.DIV_ELEM, component);
responseWriter.writeAttribute(HtmlConstants.ID_ATTRIBUTE, component.getClientId() + "Items", null);
this.encodeItems(context, component, clientSelectItems);
responseWriter.endElement(HtmlConstants.DIV_ELEM);
partialWriter.endUpdate();
if (!clientSelectItems.isEmpty()) {
Map<String, Object> dataMap = ExtendedPartialViewContext.getInstance(context).getResponseComponentDataMap();
dataMap.put(component.getClientId(context), clientSelectItems);
}
} else {
throw new IllegalArgumentException(metaComponentId);
}
}
public void decodeMetaComponent(FacesContext context, UIComponent component, String metaComponentId) {
throw new UnsupportedOperationException();
}
public void renderListHandlers(FacesContext facesContext, UIComponent component) throws IOException {
RenderKitUtils.renderPassThroughAttributesOptimized(facesContext, component,
SelectHelper.SELECT_LIST_HANDLER_ATTRIBUTES);
}
public List<ClientSelectItem> getConvertedSelectItems(FacesContext facesContext, UIComponent component) {
return SelectHelper.getConvertedSelectItems(facesContext, component);
}
public String getSelectInputLabel(FacesContext facesContext, UIComponent component) {
return SelectHelper.getSelectInputLabel(facesContext, component);
}
protected String getMinListHeight(AbstractSelect select) {
String height = HtmlDimensions.formatSize(select.getMinListHeight());
if (height == null || height.length() == 0) {
height = "20px";
}
return height;
}
protected String getMaxListHeight(AbstractSelect select) {
String height = HtmlDimensions.formatSize(select.getMaxListHeight());
if (height == null || height.length() == 0) {
height = "100px";
}
return height;
}
protected String getListHeight(AbstractSelect select) {
String height = HtmlDimensions.formatSize(select.getListHeight());
if (height == null || height.length() == 0) {
height = "auto";
}
return height;
}
protected String getListWidth(AbstractSelect select) {
String width = HtmlDimensions.formatSize(select.getListWidth());
if (width == null || width.length() == 0) {
width = "200px";
}
return width;
}
public String encodeHeightAndWidth(UIComponent component) {
AbstractSelect select = (AbstractSelect) component;
String height = getListHeight(select);
if (!"auto".equals(height)) {
height = (height != null && height.trim().length() != 0) ? ("height: " + height) : "";
} else {
String minHeight = getMinListHeight(select);
minHeight = (minHeight != null && minHeight.trim().length() != 0) ? ("min-height: " + minHeight) : "";
String maxHeight = getMaxListHeight(select);
maxHeight = (maxHeight != null && maxHeight.trim().length() != 0) ? ("max-height: " + maxHeight) : "";
height = concatStyles(minHeight, maxHeight);
}
String width = getListWidth(select);
width = (width != null && width.trim().length() != 0) ? ("width: " + width) : "";
return concatStyles(height, width);
}
public String getListCss(UIComponent component) {
AbstractSelect inplaceSelect = (AbstractSelect) component;
String css = inplaceSelect.getListClass();
css = (css != null) ? concatClasses("rf-sel-lst-cord", css) : "rf-sel-lst-cord";
return css;
}
public String getSelectLabel(FacesContext facesContext, UIComponent component) {
AbstractSelectComponent select = (AbstractSelectComponent) component;
String label = getSelectInputLabel(facesContext, select);
if (label == null || "".equals(label.trim())) {
label = select.getDefaultLabel();
}
return label;
}
public boolean isAutocomplete(UIComponent component) {
if (! (component instanceof AbstractSelect)) {
return false;
}
AbstractSelect select = (AbstractSelect) component;
return select.getAutocompleteMethod() != null || select.getAutocompleteList() != null;
}
public void encodeItemsContainer(FacesContext facesContext, UIComponent component, List<ClientSelectItem> clientSelectItems) throws IOException {
ResponseWriter responseWriter = facesContext.getResponseWriter();
responseWriter.startElement(HtmlConstants.DIV_ELEM, component);
responseWriter.writeAttribute(HtmlConstants.ID_ATTRIBUTE, component.getClientId() + "Items", null);
AutocompleteMode mode = (AutocompleteMode) component.getAttributes().get("mode");
if (!isAutocomplete(component) || (mode != null && mode == AutocompleteMode.client)) {
List<Object> fetchValues = new ArrayList<Object>();
this.encodeItems(facesContext, component, clientSelectItems);
}
responseWriter.endElement(HtmlConstants.DIV_ELEM);
}
public void encodeItems(FacesContext facesContext, UIComponent component, List<ClientSelectItem> clientSelectItems)
throws IOException {
SelectHelper.encodeItems(facesContext, component, clientSelectItems, HtmlConstants.DIV_ELEM, ITEM_CSS);
}
@Override
protected void preEncodeBegin(FacesContext facesContext, UIComponent component) throws IOException {
ScriptString script = prepareCSVMessageScript(facesContext);
JavaScriptService jsService = ServiceTracker.getService(JavaScriptService.class);
jsService.addScript(facesContext, script);
}
/**
* Prepares client-side validation script for {@link SelectLabelValueValidator}
*/
private ScriptString prepareCSVMessageScript(FacesContext facesContext) {
MessageFactory messageFactory = ServiceTracker.getService(MessageFactory.class);
FacesMessage message = messageFactory.createMessage(facesContext, FacesMessage.SEVERITY_ERROR,
FacesMessages.UISELECTONE_INVALID, "{0}");
return new AddCSVMessageScript(FacesMessages.UISELECTONE_INVALID.name(), message);
}
protected int getMinCharsOrDefault(UIComponent component) {
int value = 1;
if (component instanceof AutocompleteProps) {
value = ((AutocompleteProps) component).getMinChars();
if (value < 1) {
value = 1;
}
}
return value;
}
private Object saveVar(FacesContext context, String var) {
if (var != null) {
Map<String, Object> requestMap = context.getExternalContext().getRequestMap();
return requestMap.get(var);
}
return null;
}
private void setVar(FacesContext context, String var, Object varObject) {
if (var != null) {
Map<String, Object> requestMap = context.getExternalContext().getRequestMap();
requestMap.put(var, varObject);
}
}
}