com.sun.webui.jsf.component.WebuiInput Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.
*/
package com.sun.webui.jsf.component;
import com.sun.webui.jsf.event.MethodExprValueChangeListener;
import javax.el.MethodExpression;
import javax.faces.component.UIInput;
import javax.faces.convert.Converter;
import javax.faces.event.ValueChangeListener;
import com.sun.faces.annotation.Property;
import com.sun.webui.jsf.validator.MethodExprValidator;
import java.util.List;
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import javax.faces.el.MethodBinding;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import javax.faces.event.ValueChangeEvent;
import javax.faces.validator.Validator;
import javax.faces.validator.ValidatorException;
/**
*
* @author mbohm
*/
public class WebuiInput extends UIInput {
/**
* The converter attribute is used to specify a method to translate native
* property values to String and back for this component. The converter
* attribute value must be one of the following:
*
* - A JavaServer Faces EL expression that resolves to a backing bean or
* bean property that implements the
*
javax.faces.converter.Converter interface; or
* - the ID of a registered converter (a String).
*
*/
@Property(name = "converter")
@Override
public void setConverter(Converter converter) {
super.setConverter(converter);
}
/**
* The component identifier for this component. This value must be unique
* within the closest parent component that is a naming container.
*/
@Property(name = "id")
@Override
public void setId(String id) {
super.setId(id);
}
/**
* Flag indicating that event handling for this component should be handled
* immediately (in Apply Request Values phase) rather than waiting until
* Invoke Application phase.
*/
@Property(name = "immediate")
@Override
public void setImmediate(boolean immediate) {
super.setImmediate(immediate);
}
/**
* Use the rendered attribute to indicate whether the HTML code for the
* component should be included in the rendered HTML page. If set to false,
* the rendered HTML page does not include the HTML for the component. If
* the component is not rendered, it is also not processed on any subsequent
* form submission.
*/
@Property(name = "rendered")
@Override
public void setRendered(boolean rendered) {
super.setRendered(rendered);
}
/**
* Flag indicating that an input value for this field is mandatory, and
* failure to provide one will trigger a validation error.
*/
@Property(name = "required")
@Override
public void setRequired(boolean required) {
super.setRequired(required);
}
/**
* {@inheritDoc}
**/
//Override to annotate
@Property(isHidden = true, isAttribute = false)
@Override
public MethodBinding getValidator() {
return super.getValidator();
}
/**
* {@inheritDoc}
**/
//Override to annotate
@Property(isHidden = true, isAttribute = false)
@Override
public MethodBinding getValueChangeListener() {
return super.getValueChangeListener();
}
/**
* The valueChangeListener attribute is used to specify a
* method to handle an value-change event that is triggered when the
* user enters data in the input component. The value of the
* attribute value must be a JavaServer Faces EL expression that
* resolves to a backing bean method. The method must take a single
* parameter of type javax.faces.event.ValueChangeEvent,
* and its return type must be void. The backing bean where the
* method is defined must implement java.io.Serializable
* or javax.faces.component.StateHolder.
*/
@Property(name = "valueChangeListenerExpression", isHidden = true,
displayName = "Value Change Listener Expression", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.MethodBindingPropertyEditor")
@Property.Method(event = "valueChange")
private MethodExpression valueChangeListenerExpression;
/**
* Get the valueChangeListenerExpression.
* The corresponding listener will be called from the
* broadcast method.
*/
public MethodExpression getValueChangeListenerExpression() {
return this.valueChangeListenerExpression;
}
/**
* Set the valueChangeListenerExpression.
* The corresponding listener will be called from the
* broadcast method.
*/
public void setValueChangeListenerExpression(MethodExpression me) {
this.valueChangeListenerExpression = me;
}
/**
* The validator attribute is used to specify a method in a backing bean to
* validate input to the component. The validator attribute value must be a
* JavaServer Faces EL expression that resolves to a public method with
* return type void. The method must take three parameters:
*
* - a
javax.faces.context.FacesContext
* - a
javax.faces.component.UIComponent (the component whose
* data is to be validated)
* - a
java.lang.Object containing the data to be validated.
*
*
* The backing bean where the method is defined must implement
* java.io.Serializable or
* javax.faces.component.StateHolder.
* The method is invoked during the Process Validations Phase.
*/
@Property(name = "validatorExpression", displayName = "Validator Expression",
category = "Data", editorClassName = "com.sun.rave.propertyeditors.ValidatorPropertyEditor")
@Property.Method(event = "validate")
private MethodExpression validatorExpression;
/**
* Get the validatorExpression.
* The corresponding validator will be called from the
* validateValue method.
*
*/
public MethodExpression getValidatorExpression() {
return this.validatorExpression;
}
/**
* Set the validatorExpression.
* The corresponding validator will be called from the
* validateValue method.
*
*/
public void setValidatorExpression(MethodExpression me) {
this.validatorExpression = me;
}
/**
* {@inheritDoc}
**/
@Override
public void broadcast(FacesEvent event) throws AbortProcessingException {
// Perform standard superclass processing
super.broadcast(event);
if (event instanceof ValueChangeEvent) {
MethodExpression vclExpression = getValueChangeListenerExpression();
if (vclExpression != null) {
ValueChangeListener vcl = new MethodExprValueChangeListener(vclExpression);
//just to be sure, use the semantics of the inherited broadcast method
if (event.isAppropriateListener(vcl)) {
event.processListener(vcl);
}
}
}
}
/**
* {@inheritDoc}
**/
@Override
protected void validateValue(FacesContext context, Object newValue) {
// Perform standard superclass processing
super.validateValue(context, newValue);
// If our value is valid and not empty, try to call validatorExpression
if (isValid() && !isEmpty(newValue)) {
MethodExpression vExpression = getValidatorExpression();
if (vExpression != null) {
Validator validator = new MethodExprValidator(vExpression);
try {
validator.validate(context, this, newValue);
} catch (ValidatorException ve) {
// If the validator throws an exception, we're
// invalid, and we need to add a message
setValid(false);
FacesMessage message = null;
String validatorMessageString = getValidatorMessage();
if (null != validatorMessageString) {
message = new FacesMessage(validatorMessageString,
validatorMessageString);
} else {
message = ve.getFacesMessage();
}
if (message != null) {
message.setSeverity(FacesMessage.SEVERITY_ERROR);
context.addMessage(getClientId(context), message);
}
}
}
}
}
/**
* Emulate the corresponding private method in UIInput.
* Use protected access since this method is called by
* validateValue, which has protected access.
*/
protected boolean isEmpty(Object value) {
if (value == null) {
return (true);
} else if ((value instanceof String) &&
(((String) value).length() < 1)) {
return (true);
} else if (value.getClass().isArray()) {
if (0 == java.lang.reflect.Array.getLength(value)) {
return (true);
}
} else if (value instanceof List) {
if (0 == ((List) value).size()) {
return (true);
}
}
return (false);
}
/**
* {@inheritDoc}
**/
@Override
public void restoreState(FacesContext context, Object state) {
Object values[] = (Object[]) state;
super.restoreState(context, values[0]);
valueChangeListenerExpression = (MethodExpression) restoreAttachedState(context, values[1]);
validatorExpression = (MethodExpression) restoreAttachedState(context, values[2]);
}
/**
* {@inheritDoc}
**/
@Override
public Object saveState(FacesContext context) {
Object values[] = new Object[3];
values[0] = super.saveState(context);
values[1] = saveAttachedState(context, valueChangeListenerExpression);
values[2] = saveAttachedState(context, validatorExpression);
return values;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy