Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 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.
  */
 
 package javax.faces.component;
 
 

EditableValueHolder is an extension of ValueHolder that describes additional features supported by editable components, including javax.faces.event.ValueChangeEvents and javax.faces.validator.Validators.

 
 
 public interface EditableValueHolder extends ValueHolder {

    

Return the submittedValue value of this component. This method should only be used by the encodeBegin() and/or encodeEnd() methods of this component, or its corresponding javax.faces.render.Renderer. The action taken based on whether the value is null, empty, or non-null is determined based on the value of the javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param.

 
     public Object getSubmittedValue();

    

Convenience method to reset this component's value to the un-initialized state.

Since:
2.0
 
 
     public void resetValue();


    

Set the submittedValue value of this component. This method should only be used by the decode() and validate() method of this component, or its corresponding javax.faces.render.Renderer. The action taken based on whether the value is null, empty, or non-null is determined based on the value of the javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param.

Parameters:
submittedValue The new submitted value
 
     public void setSubmittedValue(Object submittedValue);

    
Return the "local value set" state for this component. Calls to setValue() automatically reset this property to true.
    public boolean isLocalValueSet();

    
Sets the "local value set" state for this component.
    public void setLocalValueSet(boolean localValueSet);



    

Return a flag indicating whether the local value of this component is valid (no conversion error has occurred).

    public boolean isValid();


    

Set a flag indicating whether the local value of this component is valid (no conversion error has occurred).

Parameters:
valid The new valid flag
    public void setValid(boolean valid);


    

Return the "required field" state for this component.

    public boolean isRequired();

    

Set the "required field" state for this component.

Parameters:
required The new "required field" state
    public void setRequired(boolean required);

    

Return the "immediate" state for this component.

    public boolean isImmediate();

    

Set the "immediate" state for this component. When set to true, the component's value will be converted and validated immediately in the Apply Request Values phase, and javax.faces.event.ValueChangeEvents will be delivered in that phase as well. The default value for this property must be false.

Parameters:
immediate The new "immediate" state
    public void setImmediate(boolean immediate);

    

If setValidator(javax.faces.el.MethodBinding) was not previously called for this instance, this method must return null. If it was called, this method must return the exact MethodBinding instance that was passed to setValidator(javax.faces.el.MethodBinding).

This method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Deprecated:
getValidators() should be used instead.
    public MethodBinding getValidator();

    

Wrap the argument validatorBinding in an implementation of javax.faces.validator.Validator and store it in the internal data structure that backs the getValidators() method, taking care to over-write any instance that was stored by a previous call to setValidator.

The argument method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Any method referenced by such an expression must be public, with a return type of void, and accept parameters of type javax.faces.context.FacesContext, UIComponent, and Object.

Deprecated:
Use addValidator(javax.faces.validator.Validator) instead, obtaining the argument javax.faces.validator.Validator by creating an instance of javax.faces.validator.MethodExpressionValidator.
Parameters:
validatorBinding The new MethodBinding instance
    public void setValidator(MethodBinding validatorBinding);

    

If setValueChangeListener(javax.faces.el.MethodBinding) was not previously called for this instance, this method must return null. If it was called, this method must return the exact MethodBinding instance that was passed to setValueChangeListener(javax.faces.el.MethodBinding).

Deprecated:
Use getValueChangeListeners() instead.
    public MethodBinding getValueChangeListener();

    

Wrap the argument valueChangeMethod in an implementation of javax.faces.event.ValueChangeListener and store it in the internal data structure that backs the getValueChangeListeners() method, taking care to over-write any instance that was stored by a previous call to setValueChangeListener.

This argument method will be called during the Process Validations or Apply Request Values phases (depending on the value of the immediate property).

Any method referenced by such an expression must be public, with a return type of void, and accept a parameter of type javax.faces.event.ValueChangeEvent.

Deprecated:
Use addValueChangeListener(javax.faces.event.ValueChangeListener) instead, obtaining the argument javax.faces.event.ValueChangeListener by creating an instance of javax.faces.event.MethodExpressionValueChangeListener.
Parameters:
valueChangeMethod The new method binding instance
    public void setValueChangeListener(MethodBinding valueChangeMethod);

    

Add a javax.faces.validator.Validator instance to the set associated with this component.

Parameters:
validator The javax.faces.validator.Validator to add
Throws:
java.lang.NullPointerException if validator is null
    public void addValidator(Validator validator);

    

Return the set of registered javax.faces.validator.Validators for this component instance. If there are no registered validators, a zero-length array is returned.

    public Validator[] getValidators();

    

Remove a javax.faces.validator.Validator instance from the set associated with this component, if it was previously associated. Otherwise, do nothing.

Parameters:
validator The javax.faces.validator.Validator to remove
    public void removeValidator(Validator validator);

    

Add a new javax.faces.event.ValueChangeListener to the set of listeners interested in being notified when javax.faces.event.ValueChangeEvents occur.

Parameters:
listener The javax.faces.event.ValueChangeListener to be added
Throws:
java.lang.NullPointerException if listener is null
    public void addValueChangeListener(ValueChangeListener listener);

    

Return the set of registered javax.faces.event.ValueChangeListeners for this component instance. If there are no registered listeners, a zero-length array is returned.

    public ValueChangeListener[] getValueChangeListeners();

    

Remove an existing javax.faces.event.ValueChangeListener (if any) from the set of listeners interested in being notified when javax.faces.event.ValueChangeEvents occur.

Parameters:
listener The javax.faces.event.ValueChangeListener to be removed
Throws:
java.lang.NullPointerException if listener is null
    public void removeValueChangeListener(ValueChangeListener listener);
New to GrepCode? Check out our FAQ X