com.sun.faces.renderkit.html_basic.CommandLinkRenderer Maven / Gradle / Ivy
/*
* $Id: CommandLinkRenderer.java,v 1.58 2006/11/06 16:50:16 rlubke Exp $
*/
/*
* 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://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
// CommandLinkRenderer.java
package com.sun.faces.renderkit.html_basic;
import javax.faces.component.UICommand;
import javax.faces.component.UIComponent;
import javax.faces.component.UIForm;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.event.ActionEvent;
import java.io.IOException;
import java.util.logging.Level;
import com.sun.faces.RIConstants;
import com.sun.faces.renderkit.RenderKitUtils;
import com.sun.faces.util.MessageUtils;
import com.sun.faces.util.Util;
/**
* CommandLinkRenderer is a class that renders the current value of
* UICommand as a HyperLink that acts like a Button.
*/
public class CommandLinkRenderer extends LinkRenderer {
private static final String SCRIPT_STATE = RIConstants.FACES_PREFIX +
"scriptState";
// ---------------------------------------------------------- Public Methods
public void decode(FacesContext context, UIComponent component) {
if (context == null) {
throw new NullPointerException(MessageUtils.getExceptionMessageString(
MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "context"));
}
if (component == null) {
throw new NullPointerException(MessageUtils.getExceptionMessageString(
MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "component"));
}
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"Begin decoding component " + component.getId());
}
UICommand command = (UICommand) component;
// If the component is disabled, do not change the value of the
// component, since its state cannot be changed.
if (Util.componentIsDisabledOrReadonly(component)) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("No decoding necessary since the component " +
component.getId() + " is disabled");
}
return;
}
String clientId = command.getClientId(context);
if (!context.getExternalContext().getRequestParameterMap()
.containsKey(clientId)) {
return;
}
ActionEvent actionEvent = new ActionEvent(component);
component.queueEvent(actionEvent);
if (logger.isLoggable(Level.FINE)) {
logger.fine("This command resulted in form submission " +
" ActionEvent queued " + actionEvent);
}
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"End decoding component " + component.getId());
}
}
public void encodeBegin(FacesContext context, UIComponent component)
throws IOException {
if (context == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"context"));
}
if (component == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"component"));
}
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"Begin encoding component " + component.getId());
}
UICommand command = (UICommand) component;
// suppress rendering if "rendered" property on the command is
// false.
if (!command.isRendered()) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("End encoding component " + component.getId() +
" since " +
"rendered attribute is set to false ");
}
return;
}
boolean componentDisabled = false;
if (Boolean.TRUE.equals(command.getAttributes().get("disabled"))) {
componentDisabled = true;
}
String formClientId = getFormClientId(component, context);
if (formClientId == null) {
if (logger.isLoggable(Level.WARNING)) {
logger.warning("component '" + component.getId() +
"' must be enclosed inside a form ");
}
}
if (componentDisabled || formClientId == null) {
renderAsDisabled(context, command);
} else {
if (!hasScriptBeenRendered(context)) {
RenderKitUtils
.renderFormInitScript(
context.getResponseWriter(),
context);
setScriptAsRendered(context);
}
renderAsActive(context, command);
}
}
public void encodeChildren(FacesContext context, UIComponent component)
throws IOException {
if (context == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"context"));
}
if (component == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"component"));
}
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"Begin encoding children " + component.getId());
}
// suppress rendering if "rendered" property on the component is
// false.
if (!component.isRendered()) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("End encoding component " + component.getId() +
" since " +
"rendered attribute is set to false ");
}
return;
}
for (UIComponent kid : component.getChildren()) {
kid.encodeBegin(context);
if (kid.getRendersChildren()) {
kid.encodeChildren(context);
}
kid.encodeEnd(context);
}
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"End encoding children " + component.getId());
}
}
public void encodeEnd(FacesContext context, UIComponent component)
throws IOException {
if (context == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"context"));
}
if (component == null) {
throw new NullPointerException(
MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID,
"component"));
}
UICommand command = (UICommand) component;
// suppress rendering if "rendered" property on the command is
// false.
if (!command.isRendered()) {
if (logger.isLoggable(Level.FINE)) {
logger.fine("End encoding component " + component.getId() +
" since " +
"rendered attribute is set to false ");
}
return;
}
ResponseWriter writer = context.getResponseWriter();
assert(writer != null);
String formClientId = getFormClientId(component, context);
if (formClientId == null) {
writer.write(MessageUtils.getExceptionMessageString(
MessageUtils.COMMAND_LINK_NO_FORM_MESSAGE_ID));
writer.endElement("span");
return;
}
//Write Anchor inline elements
boolean componentDisabled = false;
if (Boolean.TRUE.equals(command.getAttributes().get("disabled"))) {
componentDisabled = true;
}
if (componentDisabled) {
writer.endElement("span");
return;
}
//Done writing Anchor element
writer.endElement("a");
if (logger.isLoggable(Level.FINER)) {
logger.log(Level.FINER,
"End encoding component " + component.getId());
}
}
public boolean getRendersChildren() {
return true;
}
// ------------------------------------------------------- Protected Methods
protected Object getValue(UIComponent component) {
return ((UICommand) component).getValue();
}
protected String getOnClickScript(String formClientId,
String commandClientId,
String target,
Param[] params) {
return RenderKitUtils.getCommandLinkOnClickScript(formClientId,
commandClientId,
target,
params);
}
protected void renderAsActive(FacesContext context, UIComponent command)
throws IOException {
ResponseWriter writer = context.getResponseWriter();
assert(writer != null);
String formClientId = getFormClientId(command, context);
if (formClientId == null) {
if (logger.isLoggable(Level.WARNING)) {
logger.warning("component " + command.getId() +
" must be enclosed inside a form ");
}
return;
}
//make link act as if it's a button using javascript
writer.startElement("a", command);
writeIdAttributeIfNecessary(context, writer, command);
writer.writeAttribute("href", "#", "href");
RenderKitUtils.renderPassThruAttributes(context,
writer,
command,
new String[]{"target",
"onclick"});
RenderKitUtils.renderXHTMLStyleBooleanAttributes(writer, command);
// render onclick
String userOnclick = (String) command.getAttributes().get("onclick");
StringBuffer sb = new StringBuffer(128);
boolean userSpecifiedOnclick =
(userOnclick != null && !"".equals(userOnclick));
// if user specified their own onclick value, we are going to
// wrap their js and the injected js each in a function and
// execute them in a choose statement, if the user didn't specify
// an onclick, the original logic executes unaffected
if (userSpecifiedOnclick) {
sb.append("var a=function(){");
userOnclick = userOnclick.trim();
sb.append(userOnclick);
if (userOnclick.charAt(userOnclick.length() - 1) != ';') {
sb.append(';');
}
sb.append("};var b=function(){");
}
Param[] params = getParamList(command);
String commandClientId = command.getClientId(context);
String target = (String) command.getAttributes().get("target");
if (target != null) {
target = target.trim();
} else {
target = "";
}
sb.append(
getOnClickScript(formClientId,
commandClientId,
target,
params));
// we need to finish wrapping the injected js then
if (userSpecifiedOnclick) {
sb.append("};return (a()==false) ? false : b();");
}
writer.writeAttribute("onclick", sb.toString(), "onclick");
writeCommonLinkAttributes(writer, command);
// render the current value as link text.
writeValue(command, writer);
writer.flush();
}
// --------------------------------------------------------- Private Methods
/**
* @param context the FacesContext for the current request
*
* @return true If the add/remove javascript
* has been rendered, otherwise false
*/
private static boolean hasScriptBeenRendered(FacesContext context) {
return (context.getExternalContext().getRequestMap()
.get(SCRIPT_STATE) != null);
}
/**
* Set a flag to indicate that the add/remove javascript
* has been rendered for the current form.
*
* @param context the FacesContext of the current request
*/
@SuppressWarnings("unchecked")
private static void setScriptAsRendered(FacesContext context) {
context.getExternalContext().getRequestMap()
.put(SCRIPT_STATE, Boolean.TRUE);
}
/**
*
Utility method to return the client ID of the parent form.
*
* @param component typically a command component
* @param context the FacesContext for the current request
*
* @return the client ID of the parent form, if any
*/
private String getFormClientId(UIComponent component,
FacesContext context) {
UIForm form = getMyForm(component);
if (form != null) {
return form.getClientId(context);
}
return null;
}
private UIForm getMyForm(UIComponent component) {
UIComponent parent = component.getParent();
while (parent != null) {
if (parent instanceof UIForm) {
break;
}
parent = parent.getParent();
}
if (null == parent) {
if (logger.isLoggable(Level.WARNING)) {
logger.warning("component " + component.getId() +
" must be enclosed inside a form ");
}
}
return (UIForm) parent;
}
} // end of class CommandLinkRenderer