com.icesoft.faces.renderkit.dom_html_basic.CommandLinkRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
The newest version!
/*
* Copyright 2004-2013 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 com.icesoft.faces.renderkit.dom_html_basic;
import com.icesoft.faces.component.AttributeConstants;
import com.icesoft.faces.context.DOMContext;
import org.icefaces.impl.util.DOMUtils;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
import javax.faces.FacesException;
import javax.faces.component.UINamingContainer;
import javax.faces.component.UICommand;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.event.ActionEvent;
import java.beans.Beans;
import java.io.IOException;
import java.util.Iterator;
import java.util.Map;
public class CommandLinkRenderer extends DomBasicRenderer {
private static final String[] passThruAttributes = AttributeConstants.getAttributes(AttributeConstants.H_COMMANDLINK);
private static final String HIDDEN_FIELD_NAME = "cl";
public void decode(FacesContext facesContext, UIComponent uiComponent) {
validateParameters(facesContext, uiComponent, UICommand.class);
if (isStatic(uiComponent)) {
return;
}
String commandLinkClientId = uiComponent.getClientId(facesContext);
Map requestParameterMap =
facesContext.getExternalContext().getRequestParameterMap();
String commonCommandLinkHiddenFieldName = deriveCommonHiddenFieldName(facesContext, uiComponent);
String hiddenFieldNameInRequestMap = (String) requestParameterMap.get(commonCommandLinkHiddenFieldName);
if (hiddenFieldNameInRequestMap == null
|| hiddenFieldNameInRequestMap.equals("")
|| !commandLinkClientId.equals(hiddenFieldNameInRequestMap)) {
// this command link did not invoke the submit
return;
}
// this command link caused the submit so queue an event
uiComponent.queueEvent(new ActionEvent(uiComponent));
}
protected static String deriveCommonHiddenFieldName(FacesContext facesContext, UIComponent uiComponent) {
if (Beans.isDesignTime()) {
return "";
}
UIComponent parentNamingContainer = findForm(uiComponent);
String parentClientId = parentNamingContainer.getClientId(facesContext);
String hiddenFieldName = parentClientId
+ UINamingContainer.getSeparatorChar(facesContext)
+ UIViewRoot.UNIQUE_ID_PREFIX
+ HIDDEN_FIELD_NAME;
return hiddenFieldName;
}
public void encodeBegin(FacesContext facesContext, UIComponent uiComponent)
throws IOException {
validateParameters(facesContext, uiComponent, UICommand.class);
DOMContext domContext =
DOMContext.attachDOMContext(facesContext, uiComponent);
boolean disabled = false;
try {
disabled = Boolean.valueOf(String.valueOf(uiComponent.getAttributes().get("disabled"))).booleanValue();
} catch (Exception e) {
}
if (!domContext.isInitialized()) {
Element root;
if (disabled) {
root = domContext.createElement("span");
} else {
root = domContext.createElement("a");
root.setAttribute("href", "javascript:;");
}
domContext.setRootNode(root);
setRootElementId(facesContext, root, uiComponent);
}
Element root = (Element) domContext.getRootNode();
DOMContext.removeChildren(root);
renderLinkText(uiComponent, domContext, root);
PassThruAttributeRenderer.renderHtmlAttributes(facesContext, uiComponent, passThruAttributes);
Map parameterMap = getParameterMap(uiComponent);
renderOnClick(facesContext, uiComponent, root, parameterMap);
String styleClass = (String) uiComponent.getAttributes().get("styleClass");
if (styleClass != null) {
root.setAttribute("class", styleClass);
}
if (disabled) {
root.removeAttribute("disabled");
}
FormRenderer.addHiddenField(facesContext, deriveCommonHiddenFieldName(facesContext, uiComponent));
Iterator parameterKeys = parameterMap.keySet().iterator();
while (parameterKeys.hasNext()) {
String nextKey = (String) parameterKeys.next();
FormRenderer.addHiddenField(facesContext, nextKey);
}
domContext.stepInto(uiComponent);
}
private void renderLinkText(UIComponent uiComponent, DOMContext
domContext, Element root) {
Object currentValue = ((UICommand) uiComponent).getValue();
String linkText = null;
if (currentValue != null) {
//no need to escape here as this is performed by createTextNode()
linkText = currentValue.toString();
}
// create a new or update the old text node for the label
if (linkText != null && linkText.length() != 0) {
Text labelNode = (Text) root.getFirstChild();
if (labelNode == null) {
labelNode = domContext.createTextNode(linkText);
root.appendChild(labelNode);
} else {
labelNode.setData(linkText);
}
}
}
protected void renderOnClick(FacesContext facesContext,
UIComponent uiComponent,
Element root, Map parameters) {
UIComponent uiForm = findForm(uiComponent);
if (uiForm == null) {
throw new FacesException("CommandLink must be contained in a form");
}
Object onClick = uiComponent.getAttributes().get(HTML.ONCLICK_ATTR);
//if onClick attribute set by the user, pre append it.
String rendererOnClick = getJavaScriptOnClickString(facesContext, uiComponent, parameters);
root.setAttribute("onclick", combinedPassThru((String) onClick, rendererOnClick));
}
public void encodeEnd(FacesContext facesContext, UIComponent uiComponent)
throws IOException {
validateParameters(facesContext, uiComponent, UICommand.class);
DOMContext domContext = DOMContext.getDOMContext(facesContext, uiComponent);
domContext.stepOver();
}
private String getJavaScriptOnClickString(FacesContext facesContext, UIComponent uiComponent, Map parameters) {
return getJavascriptHiddenFieldSetters(facesContext, (UICommand) uiComponent, parameters) +
"iceSubmit(form,this,event);" +
getJavascriptHiddenFieldReSetters(facesContext, (UICommand) uiComponent, parameters) + "return false;";
}
/**
* @param facesContext
* @param uiCommand
* @param parameters
* @return
*/
protected static String getJavascriptHiddenFieldSetters(
FacesContext facesContext,
UICommand uiCommand, Map parameters) {
StringBuffer buffer;
buffer = new StringBuffer("var form=formOf(this);form['");
buffer.append(deriveCommonHiddenFieldName(facesContext, uiCommand));
buffer.append("'].value='");
buffer.append(uiCommand.getClientId(facesContext));
buffer.append("';");
Iterator parameterKeys = parameters.keySet().iterator();
while (parameterKeys.hasNext()) {
String nextParamName = (String) parameterKeys.next();
Object nextParamValue = parameters.get(nextParamName);
buffer.append("form['");
buffer.append(nextParamName);
buffer.append("'].value='");
//ICE-8415: need to escape any single quotes in the value
//of the parameter to ensure a valid JavaScript string.
buffer.append(escapeQuote(nextParamValue));
buffer.append("';");
}
return buffer.toString();
}
protected static String escapeQuote(Object value) {
if (null == value) {
return "";
}
char[] chars = value.toString().toCharArray();
StringBuffer buffer = new StringBuffer(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();
}
protected static String getJavascriptHiddenFieldReSetters(
FacesContext facesContext,
UICommand uiCommand, Map parameters) {
StringBuffer buffer;
buffer = new StringBuffer("form['");
buffer.append(deriveCommonHiddenFieldName(facesContext, uiCommand));
buffer.append("'].value='");
// buffer.append(uiCommand.getClientId(facesContext));
buffer.append("';");
Iterator parameterKeys = parameters.keySet().iterator();
while (parameterKeys.hasNext()) {
String nextParamName = (String) parameterKeys.next();
Object nextParamValue = parameters.get(nextParamName);
buffer.append("form['");
buffer.append(nextParamName);
buffer.append("'].value='");
// buffer.append(nextParamValue);
buffer.append("';");
}
return buffer.toString();
}
public boolean getRendersChildren() {
return false;
}
}