org.icefaces.ace.component.selectmenu.SelectMenuRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-ace Show documentation
Show all versions of icefaces-ace Show documentation
${icefaces.product.name} ACE Component Library
/*
* Copyright 2004-2014 ICEsoft Technologies Canada Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an "AS
* IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.icefaces.ace.component.selectmenu;
import org.icefaces.ace.renderkit.InputRenderer;
import org.icefaces.ace.util.ComponentUtils;
import org.icefaces.ace.util.HTML;
import org.icefaces.component.PassthroughAttributes;
import org.icefaces.render.MandatoryResourceComponent;
import org.icefaces.ace.util.JSONBuilder;
import org.icefaces.util.EnvUtils;
import org.icefaces.ace.event.TextChangeEvent;
import javax.faces.component.UIComponent;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.event.ActionEvent;
import javax.faces.model.SelectItem;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.el.ELContext;
import javax.el.ValueExpression;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.io.IOException;
@MandatoryResourceComponent(tagName="selectMenu", value="org.icefaces.ace.component.selectmenu.SelectMenu")
public class SelectMenuRenderer extends InputRenderer {
private static final String[] PASSTHROUGH_ATTRIBUTES = ((PassthroughAttributes) SelectMenu.class.getAnnotation(PassthroughAttributes.class)).value();
private static final String AUTOCOMPLETE_DIV = "_div";
private static final String LABEL_CLASS = "ui-selectmenu-item-label";
private static final String VALUE_CLASS = "ui-selectmenu-item-value";
private static String escapeSingleQuote(String text) {
if (null == text) {
return "";
}
char[] chars = text.toCharArray();
StringBuilder buffer = new StringBuilder(chars.length);
for (int index = 0; index < chars.length; index++) {
char ch = chars[index];
if (ch == '\'') {
buffer.append("'");
} else {
buffer.append(ch);
}
}
return buffer.toString();
}
private static String escapeJavascriptString(String str) {
if (str == null) return "";
return str.replace("\\", "\\\\").replace("\'","\\'");
}
// taken from com.icesoft.faces.renderkit.dom_html_basic.DomBasicRenderer
public static void encodeParentAndChildren(FacesContext facesContext, UIComponent parent) throws IOException {
parent.encodeBegin(facesContext);
if (parent.getRendersChildren()) {
parent.encodeChildren(facesContext);
} else {
if (parent.getChildCount() > 0) {
Iterator children = parent.getChildren().iterator();
while (children.hasNext()) {
UIComponent nextChild = (UIComponent) children.next();
if (nextChild.isRendered()) {
encodeParentAndChildren(facesContext, nextChild);
}
}
}
}
parent.encodeEnd(facesContext);
}
public boolean getRendersChildren() {
return true;
}
public void decode(FacesContext facesContext, UIComponent uiComponent) {
SelectMenu selectMenu = (SelectMenu) uiComponent;
selectMenu.setItemList(null);
Map requestMap = facesContext.getExternalContext().getRequestParameterMap();
String clientId = selectMenu.getClientId(facesContext);
String value = (String) requestMap.get(clientId + "_input");
selectMenu.setSubmittedValue(value);
decodeBehaviors(facesContext, selectMenu);
}
public void encodeBegin(FacesContext facesContext, UIComponent uiComponent) throws IOException {
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = uiComponent.getClientId(facesContext);
SelectMenu selectMenu = (SelectMenu) uiComponent;
int width = selectMenu.getWidth();
boolean ariaEnabled = EnvUtils.isAriaEnabled(facesContext);
Map paramMap = facesContext.getExternalContext().getRequestParameterMap();
Map labelAttributes = getLabelAttributes(uiComponent);
String inFieldLabel = (String) labelAttributes.get("inFieldLabel");
String inFieldLabelStyleClass = "";
String iceFocus = (String) paramMap.get("ice.focus");
String inputClientId = clientId + "_input";
Object _value = selectMenu.getValue();
String value = _value != null ? _value.toString() : null;
if (isValueBlank(value)) value = null;
boolean labelIsInField = false;
if (value == null && !isValueBlank(inFieldLabel) && !inputClientId.equals(iceFocus)) {
inFieldLabelStyleClass = " " + IN_FIELD_LABEL_STYLE_CLASS;
labelIsInField = true;
}
// root
writer.startElement("div", uiComponent);
writer.writeAttribute("id", clientId, null);
writer.writeAttribute("class", "ui-selectmenu " + selectMenu.getStyleClass(), null);
renderResetSettings(facesContext, uiComponent);
String dir = selectMenu.getDir();
if (dir != null) writer.writeAttribute("data-dir", dir, null);
String lang = selectMenu.getLang();
if (lang != null) writer.writeAttribute("lang", lang, null);
String title = selectMenu.getTitle();
if (title != null) writer.writeAttribute("title", title, null);
writeLabelAndIndicatorBefore(labelAttributes);
// value field
writer.startElement("a", null);
boolean disabled = selectMenu.isDisabled();
boolean readonly = selectMenu.isReadonly();
String disabledClass = "";
if (disabled) disabledClass = " ui-state-disabled ";
writer.writeAttribute("class", "ui-widget ui-widget-content ui-corner-all ui-selectmenu-value " + getStateStyleClasses(selectMenu) + " " + disabledClass, null);
writer.writeAttribute("style", "display: inline-block; width: " + width + "px;", null);
writer.writeAttribute("id", clientId + "_link", null);
String tabindex = selectMenu.getTabindex();
if (tabindex != null) writer.writeAttribute("tabindex", tabindex, null);
String accesskey = selectMenu.getAccesskey();
if (accesskey != null) {
writer.writeAttribute("accesskey", accesskey, null);
if (tabindex == null) writer.writeAttribute("tabindex", "0", null);
}
else if (tabindex == null) writer.writeAttribute("tabindex", "0", null);
ComponentUtils.renderPassThroughAttributes(writer, selectMenu, PASSTHROUGH_ATTRIBUTES);
if (ariaEnabled) {
writer.writeAttribute("role", "select", null);
final SelectMenu component = (SelectMenu) uiComponent;
Map ariaAttributes = new HashMap() {{
put("required", component.isRequired());
put("disabled", component.isDisabled());
put("invalid", !component.isValid());
}};
writeAriaAttributes(ariaAttributes, labelAttributes);
}
// text span
writer.startElement("span", null);
writer.writeAttribute("style", selectMenu.getStyle(), null);
writer.writeAttribute("class", "ui-inputfield ui-corner-left " + inFieldLabelStyleClass, null);
if (dir != null) writer.writeAttribute("dir", dir, null);
writer.endElement("span");
// down arrow span
writer.startElement("span", null);
writer.writeAttribute("class", "ui-state-default ui-corner-right ui-selectmenu-button", null);
writer.startElement("span", null);
writer.writeAttribute("class", "fa fa-chevron-down", null);
writer.endElement("span");
writer.endElement("span");
writer.endElement("a");
writeLabelAndIndicatorAfter(labelAttributes);
writer.startElement("input", null);
writer.writeAttribute("type", "text", null);
writer.writeAttribute("style", "visibility: hidden; width: 1px; height: 1px; padding: 0; margin 0; border: none;", null);
writer.writeAttribute("id", inputClientId, null);
writer.writeAttribute("name", inputClientId, null);
writer.writeAttribute("value", value, null);
if (disabled) writer.writeAttribute("disabled", "disabled", null);
if (readonly) writer.writeAttribute("readonly", "readonly", null);
writer.writeAttribute(HTML.AUTOCOMPLETE_ATTR, "off", null);
writer.endElement("input");
String divId = clientId + AUTOCOMPLETE_DIV;
writer.startElement("div", null);
writer.writeAttribute("id", divId, null);
writer.writeAttribute("class", "ui-selectmenu-list ui-widget", null);
writer.writeAttribute("style", "display:none;z-index:500;", null);
if (dir != null) writer.writeAttribute("dir", dir, null);
writer.endElement("div");
encodeScript(facesContext, writer, clientId, selectMenu,
paramMap, inFieldLabel, inputClientId, labelIsInField);
writer.endElement("div");
}
private void encodeScript(FacesContext facesContext, ResponseWriter writer, String clientId, SelectMenu selectMenu, Map paramMap, String inFieldLabel, String inputClientId, boolean labelIsInField) throws IOException {
String divId = clientId + AUTOCOMPLETE_DIV;
Object sourceId = paramMap.get("ice.event.captured");
boolean isEventSource = sourceId != null && sourceId.toString().equals(inputClientId);
// script
writer.startElement("script", null);
writer.writeAttribute("type", "text/javascript", null);
if (!selectMenu.isDisabled() && !selectMenu.isReadonly()) {
JSONBuilder jb = JSONBuilder.create();
jb.beginFunction("ice.ace.create")
.item("SelectMenu")
.beginArray()
.item(clientId)
.item(divId)
.item("ui-widget-content")
.item("ui-state-hover")
.item("ui-state-active")
.item(selectMenu.getHeight())
.item(selectMenu.getDirection())
.beginMap()
.entry("p", ""); // dummy property
encodeClientBehaviors(facesContext, selectMenu, jb);
jb.endMap();
jb.beginMap()
.entryNonNullValue("inFieldLabel", inFieldLabel)
.entry("inFieldLabelStyleClass", IN_FIELD_LABEL_STYLE_CLASS)
.entry("labelIsInField", labelIsInField)
.entry("showListOnInput", selectMenu.isShowListOnInput())
.endMap();
// effects
jb.beginMap()
.entry("show", selectMenu.getShowEffect())
.entry("showLength", selectMenu.getShowEffectLength())
.entry("hide", selectMenu.getHideEffect())
.entry("hideLength", selectMenu.getHideEffectLength())
.endMap();
jb.endArray();
jb.endFunction();
writer.writeText(jb.toString(), null);
} else {
writer.writeText("ice.ace.SelectMenu.setDimensionsOnly('"+clientId+"', '"+divId+"');", null);
}
// render style, style class and required state as a comment to cause a full component update when they change
writer.writeText("// " + selectMenu.getStyle() + " " + selectMenu.getStyleClass() + " "
+ getStateStyleClasses(selectMenu) + " " + selectMenu.getWidth() + " " + selectMenu.isRequired(), null);
writer.endElement("script");
populateList(facesContext, selectMenu);
// field update script
Object value = selectMenu.getValue();
if (value == null) value = "";
writer.startElement("span", null);
writer.writeAttribute("id", clientId + "_fieldupdate", null);
writer.startElement("script", null);
writer.writeAttribute("type", "text/javascript", null);
writer.writeText("(function() {", null);
writer.writeText("var instance = ice.ace.SelectMenus[\"" + clientId + "\"];", null);
writer.writeText("if (instance) instance.updateValue('"
+ escapeJavascriptString(getConvertedValueForClient(facesContext, selectMenu, value))
+ "');", null);
writer.writeText("})();", null);
writer.endElement("script");
writer.endElement("span");
}
public void populateList(FacesContext facesContext, SelectMenu selectMenu) throws IOException {
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = selectMenu.getClientId(facesContext);
boolean ariaEnabled = EnvUtils.isAriaEnabled(facesContext);
selectMenu.populateItemList();
Iterator matches = selectMenu.getItemListIterator();
writer.startElement("div", null);
writer.writeAttribute("id", clientId + "_update", null);
if (selectMenu.getSelectFacet() != null) {
UIComponent facet = selectMenu.getSelectFacet();
ValueExpression itemValue = selectMenu.getValueExpression("itemValue");
ValueExpression itemDisabled = selectMenu.getValueExpression("itemDisabled");
ELContext elContext = facesContext.getELContext();
String listVar = selectMenu.getListVar();
writer.startElement("div", null);
writer.writeAttribute("style", "display: none;", null);
writer.startElement("div", null);
Map requestMap = facesContext.getExternalContext().getRequestMap();
//set index to 0, so child components can get client id from selectMenu component
selectMenu.setIndex(0);
while (matches.hasNext()) {
requestMap.put(listVar, matches.next());
Object value = itemValue.getValue(elContext);
boolean disabled = false;
try {
disabled = (Boolean) itemDisabled.getValue(elContext);
} catch (Exception e) {}
String styleClass = "ui-selectmenu-facet";
writer.startElement("div", null);
if (ariaEnabled) writer.writeAttribute("role", "option", null);
if (disabled) styleClass += " ui-state-disabled";
writer.writeAttribute("class", styleClass, null);
writer.startElement("span", null); // span to display
writer.writeAttribute("class", LABEL_CLASS, null);
encodeParentAndChildren(facesContext, facet);
writer.endElement("span");
writer.startElement("span", null); // value span
writer.writeAttribute("class", VALUE_CLASS, null);
writer.writeAttribute("style", "visibility:hidden;display:none;", null);
if (value != null) {
try {
value = getConvertedValueForClient(facesContext, selectMenu, value);
} catch (Exception e) {
value = value.toString();
}
}
if (value != null) {
writer.writeText(value, null);
}
writer.endElement("span");
selectMenu.resetId(facet);
writer.endElement("div");
requestMap.remove(listVar);
}
selectMenu.setIndex(-1);
writer.endElement("div");
String call = "var instance = ice.ace.SelectMenus[\"" + clientId +
"\"]; if (instance) instance.setContent(ice.ace.jq(ice.ace.escapeClientId('" + clientId + "_update')).get(0).firstChild.innerHTML);";
encodeDynamicScript(facesContext, selectMenu, call);
writer.endElement("div");
} else {
if (matches.hasNext()) {
StringBuffer sb = new StringBuffer("");
SelectItem item = null;
String role = "";
if (ariaEnabled) role = " role=\"option\"";
boolean first = true;
while (matches.hasNext()) {
item = (SelectItem) matches.next();
boolean last = !matches.hasNext();
String itemLabel = item.getLabel();
Object itemValue = item.getValue();
if (itemValue != null) {
try {
itemValue = getConvertedValueForClient(facesContext, selectMenu, itemValue);
} catch (Exception e) {
itemValue = itemValue.toString();
}
} else {
itemValue = "";
}
itemLabel = itemLabel == null ? itemValue.toString() : itemLabel;
itemLabel = "".equals(itemLabel.trim()) ? " " : itemLabel;
String styleClass = "";
if (item.isDisabled()) {
styleClass += " ui-state-disabled";
}
if (first){
styleClass += " ui-corner-tr ui-corner-tl";
}
if (last){
styleClass += " ui-corner-br ui-corner-bl";
}
sb.append("");
// label span
sb.append("").append(itemLabel).append("");
// value span
sb.append("");
sb.append("");
first = false;
}
sb.append("");
String call = "var instance = ice.ace.SelectMenus[\"" + clientId + "\"]; " +
"if (instance) instance.setContent('" + escapeSingleQuote(sb.toString()) + "');";
encodeDynamicScript(facesContext, selectMenu, call);
}
}
writer.endElement("div");
}
public void encodeDynamicScript(FacesContext facesContext, UIComponent uiComponent, String call) throws IOException {
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = uiComponent.getClientId(facesContext);
writer.startElement("span", null);
writer.startElement("script", null);
writer.writeAttribute("type", "text/javascript", null);
writer.writeText("(function() {" + call + "})();", null);
writer.endElement("script");
writer.endElement("span");
}
public void encodeEnd(FacesContext facesContext, UIComponent uiComponent) throws IOException {
}
public String getConvertedValueForClient(FacesContext context, UIComponent component, Object value) throws ConverterException {
SelectMenu selectMenu = (SelectMenu) component;
Converter converter = selectMenu.getConverter();
if(converter != null) {
return converter.getAsString(context, selectMenu, value);
} else {
ValueExpression ve = selectMenu.getValueExpression("value");
if(ve != null) {
Class valueType = ve.getType(context.getELContext());
Converter converterForType = context.getApplication().createConverter(valueType);
if(converterForType != null) {
if (converterForType instanceof javax.faces.convert.EnumConverter && "".equals(value)) return converterForType.getAsString(context, selectMenu, null);
return converterForType.getAsString(context, selectMenu, value);
}
}
}
return (value != null ? value.toString() : "");
}
protected void renderResetSettings(FacesContext context, UIComponent component) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = component.getClientId(context);
String labelPosition = (String) component.getAttributes().get("labelPosition");
JSONBuilder jb = JSONBuilder.create();
jb.beginArray();
jb.item("SelectMenu");
jb.beginArray();
jb.item(clientId);
if ("inField".equals(labelPosition)) {
SelectMenu selectMenu = (SelectMenu) component;
String label = (String) component.getAttributes().get("label");
String indicatorPosition = (String) component.getAttributes().get("indicatorPosition");
String optionalIndicator = (String) component.getAttributes().get("optionalIndicator");
String requiredIndicator = (String) component.getAttributes().get("requiredIndicator");
if ("labelLeft".equals(indicatorPosition)) {
if (selectMenu.isRequired())
label = requiredIndicator + label;
else
label = optionalIndicator + label;
} else if ("labelRight".equals(indicatorPosition)) {
if (selectMenu.isRequired())
label = label + requiredIndicator;
else
label = label + optionalIndicator;
}
jb.item(label);
jb.item(IN_FIELD_LABEL_STYLE_CLASS);
}
jb.endArray();
jb.endArray();
writer.writeAttribute("data-ice-reset", jb.toString(), null);
}
}