com.sun.faces.facelets.tag.jsf.core.ValueChangeListenerHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.0 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2005-2007 The Apache Software Foundation
*
* 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.sun.faces.facelets.tag.jsf.core;
import com.sun.faces.facelets.tag.TagHandlerImpl;
import com.sun.faces.facelets.tag.jsf.CompositeComponentTagHandler;
import com.sun.faces.facelets.util.ReflectionUtil;
import javax.el.ValueExpression;
import javax.faces.application.Resource;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.ValueChangeEvent;
import javax.faces.event.ValueChangeListener;
import javax.faces.view.EditableValueHolderAttachedObjectHandler;
import javax.faces.view.facelets.*;
import java.io.IOException;
import java.io.Serializable;
/**
* Register an ValueChangeListener instance on the UIComponent associated with
* the closest parent UIComponent custom action. See tag
* documentation.
*
* @author Jacob Hookom
*/
public final class ValueChangeListenerHandler extends TagHandlerImpl implements EditableValueHolderAttachedObjectHandler {
private static class LazyValueChangeListener implements
ValueChangeListener,
Serializable {
private static final long serialVersionUID = 7613811124326963180L;
private final String type;
private final ValueExpression binding;
public LazyValueChangeListener(String type, ValueExpression binding) {
this.type = type;
this.binding = binding;
}
public void processValueChange(ValueChangeEvent event)
throws AbortProcessingException {
ValueChangeListener instance = null;
FacesContext faces = FacesContext.getCurrentInstance();
if (faces == null) {
return;
}
if (this.binding != null) {
instance = (ValueChangeListener) binding
.getValue(faces.getELContext());
}
if (instance == null && this.type != null) {
try {
instance = (ValueChangeListener) ReflectionUtil
.forName(this.type).newInstance();
} catch (Exception e) {
throw new AbortProcessingException(
"Couldn't Lazily instantiate ValueChangeListener",
e);
}
if (this.binding != null) {
binding.setValue(faces.getELContext(), instance);
}
}
if (instance != null) {
instance.processValueChange(event);
}
}
}
private final TagAttribute binding;
private final String listenerType;
public ValueChangeListenerHandler(TagConfig config) {
super(config);
this.binding = this.getAttribute("binding");
TagAttribute type = this.getAttribute("type");
if (type != null) {
if (!type.isLiteral()) {
throw new TagAttributeException(type,
"Must be a literal class name of type ValueChangeListener");
} else {
// test it out
try {
ReflectionUtil.forName(type.getValue());
} catch (ClassNotFoundException e) {
throw new TagAttributeException(type,
"Couldn't qualify ValueChangeListener", e);
}
}
this.listenerType = type.getValue();
} else {
this.listenerType = null;
}
}
/**
* See taglib documentation.
*
* @see com.sun.faces.facelets.FaceletHandler#apply(com.sun.faces.facelets.FaceletContext, javax.faces.component.UIComponent)
*/
public void apply(FaceletContext ctx, UIComponent parent)
throws IOException {
// only process if it's been created
if (parent == null || !(ComponentHandler.isNew(parent))) {
return;
}
if (parent instanceof EditableValueHolder) {
applyAttachedObject(ctx.getFacesContext(), parent);
} else if (parent.getAttributes().containsKey(Resource.COMPONENT_RESOURCE_KEY)) {
// Allow the composite component to know about the target
// component.
CompositeComponentTagHandler.getAttachedObjectHandlers(parent).add(this);
} else {
throw new TagException(this.tag,
"Parent is not of type EditableValueHolder, type is: " + parent);
}
}
public void applyAttachedObject(FacesContext context, UIComponent parent) {
FaceletContext ctx = (FaceletContext) context.getAttributes().get(FaceletContext.FACELET_CONTEXT_KEY);
EditableValueHolder evh = (EditableValueHolder) parent;
ValueExpression b = null;
if (this.binding != null) {
b = this.binding.getValueExpression(ctx, ValueChangeListener.class);
}
ValueChangeListener listener = new LazyValueChangeListener(
this.listenerType, b);
evh.addValueChangeListener(listener);
}
public String getFor() {
String result = null;
TagAttribute attr = this.getAttribute("for");
if (null != attr) {
result = attr.getValue();
}
return result;
}
}