/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.myfaces.tobago.compat;
import org.apache.myfaces.tobago.event.TabChangeSource;
import org.apache.myfaces.tobago.event.ValueExpressionPopupActionListener;
import org.apache.myfaces.tobago.event.ValueExpressionResetInputActionListener;
import org.apache.myfaces.tobago.event.ValueExpressionTabChangeListener;
import org.apache.myfaces.tobago.util.ValueExpressionComparator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.el.ExpressionFactory;
import javax.el.MethodExpression;
import javax.el.ValueExpression;
import javax.faces.component.ActionSource;
import javax.faces.component.ContextCallback;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UINamingContainer;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import javax.faces.el.EvaluationException;
import javax.faces.el.MethodBinding;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import javax.faces.validator.MethodExpressionValidator;
import java.util.Comparator;
public final class FacesUtilsEL {
private static final Logger LOG = LoggerFactory.getLogger(FacesUtilsEL.class);
private FacesUtilsEL() {
}
/**
* @deprecated since 2.0.0
*/
public static boolean invokeOnComponent(
final FacesContext context, final UIComponent component, final String clientId, final ContextCallback callback) {
final String thisClientId = component.getClientId(context);
if (clientId.equals(thisClientId)) {
callback.invokeContextCallback(context, component);
return true;
} else if (component instanceof NamingContainer) {
// This component is a naming container. If the client id shows it's inside this naming container,
// then process further.
// Otherwise we know the client id we're looking for is not in this naming container,
// so for improved performance short circuit and return false.
if (clientId.startsWith(thisClientId)
&& (clientId.charAt(thisClientId.length()) == UINamingContainer.getSeparatorChar(context))) {
if (invokeOnComponentFacetsAndChildren(context, component, clientId, callback)) {
return true;
}
}
} else {
if (invokeOnComponentFacetsAndChildren(context, component, clientId, callback)) {
return true;
}
}
return false;
}
private static boolean invokeOnComponentFacetsAndChildren(
final FacesContext context, final UIComponent component, final String clientId, final ContextCallback callback) {
for (final java.util.Iterator<UIComponent> it = component.getFacetsAndChildren(); it.hasNext();) {
final UIComponent child = it.next();
if (child.invokeOnComponent(context, clientId, callback)) {
return true;
}
}
return false;
}
/**
* @deprecated since 2.0.0
*/
@Deprecated
public static void invokeMethodBinding(
final FacesContext facesContext, final MethodBinding methodBinding, final FacesEvent event) {
if (methodBinding != null && event != null) {
try {
methodBinding.invoke(facesContext, new Object[]{event});
} catch (final EvaluationException e) {
final Throwable cause = e.getCause();
if (cause instanceof AbortProcessingException) {
throw (AbortProcessingException) cause;
} else {
throw e;
}
}
}
}
public static void invokeMethodExpression(
final FacesContext facesContext, final MethodExpression methodExpression, final FacesEvent event) {
if (methodExpression != null && event != null) {
try {
methodExpression.invoke(facesContext.getELContext(), new Object[]{event});
} catch (final Exception e) {
throw new AbortProcessingException(e);
}
}
}
/**
* @deprecated since 2.0.0
*/
@Deprecated
public static Object getValueFromValueBindingOrValueExpression(
final FacesContext context, final UIComponent component, final String name) {
return component.getValueExpression(name).getValue(context.getELContext());
}
public static boolean hasValueBindingOrValueExpression(final UIComponent component, final String name) {
return component.getValueExpression(name) != null;
}
public static boolean isReadonlyValueBindingOrValueExpression(
final FacesContext context, final UIComponent component, final String name) {
return component.getValueExpression(name).isReadOnly(context.getELContext());
}
public static String getExpressionString(final UIComponent component, final String name) {
return component.getValueExpression(name).getExpressionString();
}
public static void setValueOfBindingOrExpression(
final FacesContext context, final Object value, final UIComponent component, final String bindingName) {
final ValueExpression ve = component.getValueExpression(bindingName);
if (ve != null) {
ve.setValue(context.getELContext(), value);
}
}
public static void setValueOfBindingOrExpression(
final FacesContext context, final Object value, final Object bindingOrExpression) {
if (bindingOrExpression instanceof ValueExpression) {
final ValueExpression ve = (ValueExpression) bindingOrExpression;
ve.setValue(context.getELContext(), value);
}
}
public static void copyValueBindingOrValueExpression(
final UIComponent fromComponent, final String fromName, final UIComponent toComponent, final String toName) {
final ValueExpression ve = fromComponent.getValueExpression(fromName);
if (ve != null) {
toComponent.setValueExpression(toName, ve);
}
}
public static Object getValueFromBindingOrExpression(final Object obj) {
if (obj instanceof ValueExpression) {
final ValueExpression expression = (ValueExpression) obj;
return expression.getValue(FacesContext.getCurrentInstance().getELContext());
}
return null;
}
/**
* @deprecated Since 2.0.0, please use {@link FacesUtilsEL#createValueExpression(String string)}
*/
@Deprecated
public static Object createExpressionOrBinding(final String string) {
return createValueExpression(string);
}
public static ValueExpression createValueExpression(final String string) {
final FacesContext facesContext = FacesContext.getCurrentInstance();
final ExpressionFactory expressionFactory = facesContext.getApplication().getExpressionFactory();
return expressionFactory.createValueExpression(facesContext.getELContext(), string, Object.class);
}
/**
* @deprecated since 2.0.0
*/
public static void setValidator(final EditableValueHolder editableValueHolder, final Object validator) {
if (validator instanceof MethodExpression) {
editableValueHolder.addValidator(new MethodExpressionValidator((MethodExpression) validator));
} else {
LOG.error("Unknown instance for validator: " + (validator != null ? validator.getClass().getName() : "<null>"));
}
}
/**
* @deprecated since 2.0.0
*/
public static void setConverter(final ValueHolder valueHolder, final Object converterExpression) {
if (converterExpression instanceof ValueExpression) {
final ValueExpression expression = (ValueExpression) converterExpression;
if (!expression.isLiteralText()) {
((UIComponent) valueHolder).setValueExpression("converter", expression);
} else {
valueHolder.setConverter(FacesContext.getCurrentInstance()
.getApplication().createConverter(expression.getExpressionString()));
}
}
}
/**
* @deprecated since 2.0.0
*/
public static void setBindingOrExpression(
final UIComponent component, final String name, final Object valueBindingOrExpression) {
component.setValueExpression(name, (ValueExpression) valueBindingOrExpression);
}
/**
* @deprecated since 2.0.0
*/
public static void addBindingOrExpressionTabChangeListener(
final TabChangeSource source, final String type, final Object bindingOrExpression) {
if (bindingOrExpression instanceof ValueExpression) {
source.addTabChangeListener(new ValueExpressionTabChangeListener(type, (ValueExpression) bindingOrExpression));
}
}
/**
* @deprecated since 2.0.0
*/
public static Comparator getBindingOrExpressionComparator(
final FacesContext facesContext, final UIComponent child, final String var, final boolean descending,
final Comparator comparator) {
final ValueExpression valueBinding = child.getValueExpression("value");
return new ValueExpressionComparator(facesContext, var, valueBinding, descending, comparator);
}
/**
* @deprecated since 2.0.0
*/
public static void addBindingOrExpressionPopupActionListener(
final ActionSource actionSource, final Object bindingOrExpression) {
actionSource.addActionListener(new ValueExpressionPopupActionListener((ValueExpression) bindingOrExpression));
}
/**
* @deprecated since 2.0.0
*/
public static void addBindingOrExpressionResetActionListener(
final ActionSource actionSource, final Object bindingOrExpression) {
actionSource.addActionListener(new ValueExpressionResetInputActionListener((ValueExpression) bindingOrExpression));
}
}