com.sun.faces.renderkit.html_basic.HtmlBasicInputRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
// HtmlBasicInputRenderer.java
package com.sun.faces.renderkit.html_basic;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import com.sun.faces.util.MessageFactory;
import com.sun.faces.util.MessageUtils;
import com.sun.faces.util.RequestStateManager;
import jakarta.el.PropertyNotFoundException;
import jakarta.el.ValueExpression;
import jakarta.faces.application.Application;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.UIInput;
import jakarta.faces.component.ValueHolder;
import jakarta.faces.component.behavior.ClientBehavior;
import jakarta.faces.context.FacesContext;
import jakarta.faces.convert.Converter;
import jakarta.faces.convert.ConverterException;
/**
* HtmlBasicInputRenderer is a base class for implementing renderers that support UIInput type components
*/
public abstract class HtmlBasicInputRenderer extends HtmlBasicRenderer {
private boolean hasStringConverter = false;
private boolean hasStringConverterSet = false;
// ---------------------------------------------------------- Public Methods
@Override
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException {
String newValue = (String) submittedValue;
// if we have no local value, try to get the valueExpression.
ValueExpression valueExpression = component.getValueExpression("value");
Converter converter = null;
// If there is a converter attribute, use it to to ask application
// instance for a converter with this identifer.
if (component instanceof ValueHolder) {
converter = ((ValueHolder) component).getConverter();
}
if (null == converter && null != valueExpression) {
Class converterType;
try {
converterType = valueExpression.getType(context.getELContext());
} catch (PropertyNotFoundException e) {
if (submittedValue == null) {
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE,
"Property of value expression {0} of component {1} could not be found, but submitted value is null in first place, so not attempting to convert",
new Object[]{
valueExpression.getExpressionString(),
component.getId() });
}
converterType = null; // See issue 4734.
} else {
throw e;
}
}
// if converterType is null, assume the modelType is "String".
if (converterType == null || converterType == Object.class) {
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "No conversion necessary for value {0} of component {1}", new Object[] { submittedValue, component.getId() });
}
return newValue;
}
// If the converterType is a String, and we don't have a
// converter-for-class for java.lang.String, assume the type is
// "String".
if (converterType == String.class && !hasStringConverter(context)) {
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "No conversion necessary for value {0} of component {1}", new Object[] { submittedValue, component.getId() });
}
return newValue;
}
// if getType returns a type for which we support a default
// conversion, acquire an appropriate converter instance.
try {
Application application = context.getApplication();
converter = application.createConverter(converterType);
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "Created converter ({0}) for type {1} for component {2}.",
new Object[] { converter.getClass().getName(), converterType.getClass().getName(), component.getId() });
}
} catch (Exception e) {
if (logger.isLoggable(Level.SEVERE)) {
logger.log(Level.SEVERE, "Could not instantiate converter for type {0}: {1}", new Object[] { converterType, e.toString() });
logger.log(Level.SEVERE, "", e);
}
return null;
}
} else if (converter == null) {
// if there is no valueExpression and converter attribute set,
// assume the modelType as "String" since we have no way of
// figuring out the type. So for the selectOne and
// selectMany, converter has to be set if there is no
// valueExpression attribute set on the component.
if (logger.isLoggable(Level.FINE)) {
logger.log(Level.FINE, "No conversion necessary for value {0} of component {1}", new Object[] { submittedValue, component.getId() });
logger.fine(" since there is no explicitly registered converter " + "and the component value is not bound to a model property");
}
return newValue;
}
if (converter != null) {
// If the conversion eventually falls to needing to use EL type coercion,
// make sure our special ConverterPropertyEditor knows about this value.
RequestStateManager.set(context, RequestStateManager.TARGET_COMPONENT_ATTRIBUTE_NAME, component);
return converter.getAsObject(context, component, newValue);
} else {
// throw converter exception.
Object[] params = { newValue, "null Converter" };
throw new ConverterException(MessageFactory.getMessage(context, MessageUtils.CONVERSION_ERROR_MESSAGE_ID, params));
}
}
@Override
public void setSubmittedValue(UIComponent component, Object value) {
if (component instanceof UIInput) {
((UIInput) component).setSubmittedValue(value);
if (logger.isLoggable(Level.FINE)) {
logger.fine("Set submitted value " + value + " on component ");
}
}
}
// ------------------------------------------------------- Protected Methods
@Override
protected Object getValue(UIComponent component) {
if (component instanceof ValueHolder) {
Object value = ((ValueHolder) component).getValue();
if (logger.isLoggable(Level.FINE)) {
logger.fine("component.getValue() returned " + value);
}
return value;
}
return null;
}
// Returns the Behaviors map, but only if it contains some entry other
// than those handled by renderOnchange(). This helps us optimize
// renderPassThruAttributes() in the very common case where the
// button only contains an "valueChange" (or "change") Behavior. In that
// we pass a null Behaviors map into renderPassThruAttributes(),
// which allows us to take a more optimized code path.
protected static Map> getNonOnChangeBehaviors(UIComponent component) {
return getPassThruBehaviors(component, "change", "valueChange");
}
// Returns the Behaviors map, but only if it contains some entry other
// than those handled by renderOnchange(). This helps us optimize
// renderPassThruAttributes() in the very common case where the
// button only contains an "valueChange" (or "change") Behavior. In that
// we pass a null Behaviors map into renderPassThruAttributes(),
// which allows us to take a more optimized code path.
protected static Map> getNonOnClickSelectBehaviors(UIComponent component) {
return getPassThruBehaviors(component, "click", "valueChange");
}
// --------------------------------------------------------- Private Methods
private boolean hasStringConverter(FacesContext context) {
if (!hasStringConverterSet) {
hasStringConverter = null != context.getApplication().createConverter(String.class);
hasStringConverterSet = true;
}
return hasStringConverter;
}
} // end of class HtmlBasicInputRenderer