Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: UISelectMany.java,v 1.63 2007/07/27 19:59:08 rlubke Exp $
   */
  
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   * 
   * Copyright 1997-2007 Sun Microsystems, Inc. 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.html
  * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
  * Sun designates this particular file as subject to the "Classpath" exception
  * as provided by Sun in the GPL Version 2 section of the License file that
  * accompanied this code.  If applicable, add the following below the License
  * Header, with the fields enclosed by brackets [] replaced by your own
  * identifying information: "Portions Copyrighted [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;
 
 
 import java.util.List;

UISelectMany is a UIComponent that represents the user's choice of a zero or more items from among a discrete set of available options. The user can modify the selected values. Optionally, the component can be preconfigured with zero or more currently selected items, by storing them as an array in the value property of the component.

This component is generally rendered as a select box or a group of checkboxes.

By default, the rendererType property must be set to "javax.faces.Listbox". This value can be changed by calling the setRendererType() method.

The javax.faces.render.Renderer for this component must perform the following logic on getConvertedValue():

public class UISelectMany extends UIInput {
    // ------------------------------------------------------ Manifest Constants


    

The standard component type for this component.

    public static final String COMPONENT_TYPE = "javax.faces.SelectMany";


    

The standard component family for this component.

    public static final String COMPONENT_FAMILY = "javax.faces.SelectMany";


    

The message identifier of the javax.faces.application.FacesMessage to be created if a value not matching the available options is specified.

    public static final String INVALID_MESSAGE_ID =
        "javax.faces.component.UISelectMany.INVALID";
    // ------------------------------------------------------------ Constructors


    

Create a new UISelectMany instance with default property values.

    public UISelectMany() {
        super();
        setRendererType("javax.faces.Listbox");
    }
    // -------------------------------------------------------------- Properties
    public String getFamily() {
        return ();
    }


    

Return the currently selected values, or null if there are no currently selected values. This is a typesafe alias for getValue().

    public Object[] getSelectedValues() {
        return ((Object[]) getValue());
    }


    

Set the currently selected values, or null to indicate that there are no currently selected values. This is a typesafe alias for setValue().

Parameters:
selectedValues The new selected values (if any)
    public void setSelectedValues(Object selectedValues[]) {
        setValue(selectedValues);
    }
    // ---------------------------------------------------------------- Bindings


    

Return any javax.faces.el.ValueBinding set for value if a javax.faces.el.ValueBinding for selectedValues is requested; otherwise, perform the default superclass processing for this method.

This method relies on the superclass to provide the ValueExpression to ValueBinding wrapping.

Deprecated:
this has been replaced by getValueExpression(java.lang.String).
Parameters:
name Name of the attribute or property for which to retrieve a javax.faces.el.ValueBinding
Throws:
java.lang.NullPointerException if name is null
    public ValueBinding getValueBinding(String name) {
        if ("selectedValues".equals(name)) {
            return (super.getValueBinding("value"));
        } else {
            return (super.getValueBinding(name));
        }
    }


    

Store any javax.faces.el.ValueBinding specified for selectedValues under value instead; otherwise, perform the default superclass processing for this method.

This method relies on the superclass to wrap the argument ValueBinding in a ValueExpression.

Deprecated:
This has been replaced by setValueExpression(java.lang.String,javax.el.ValueExpression).
Parameters:
name Name of the attribute or property for which to set a javax.faces.el.ValueBinding
binding The javax.faces.el.ValueBinding to set, or null to remove any currently set javax.faces.el.ValueBinding
Throws:
java.lang.NullPointerException if name is null
    public void setValueBinding(String nameValueBinding binding) {
        if ("selectedValues".equals(name)) {
            super.setValueBinding("value"binding);
        } else {
            super.setValueBinding(namebinding);
        }
    }

    

Return any javax.el.ValueExpression set for value if a javax.el.ValueExpression for selectedValues is requested; otherwise, perform the default superclass processing for this method.

Parameters:
name Name of the attribute or property for which to retrieve a javax.el.ValueExpression
Throws:
java.lang.NullPointerException if name is null
Since:
1.2
    public ValueExpression getValueExpression(String name) {
        if ("selectedValues".equals(name)) {
            return (super.getValueExpression("value"));
        } else {
            return (super.getValueExpression(name));
        }
    }
    
    

Store any javax.el.ValueExpression specified for selectedValues under value instead; otherwise, perform the default superclass processing for this method.

Parameters:
name Name of the attribute or property for which to set a javax.el.ValueExpression
binding The javax.el.ValueExpression to set, or null to remove any currently set javax.el.ValueExpression
Throws:
java.lang.NullPointerException if name is null
Since:
1.2
    public void setValueExpression(String nameValueExpression binding) {
        if ("selectedValues".equals(name)) {
            super.setValueExpression("value"binding);
        } else {
            super.setValueExpression(namebinding);
        }
    }
    
    // --------------------------------------------------------- UIInput Methods


    

Return true if the new value is different from the previous value. Value comparison must not be sensitive to element order.

Parameters:
previous old value of this component
value new value of this component
    protected boolean compareValues(Object previousObject value) {
        if ((previous == null) && (value != null)) {
            return (true);
        } else if ((previous != null) && (value == null)) {
            return (true);
        } else if ((previous == null)) {
            return (false);
        }
        boolean valueChanged = false;
        Object oldarray[];
        Object newarray[];
        // The arrays may be arrays of primitives;  for simplicity,
        // perform the boxing here.
        if (!(previous instanceof Object[])) {
            previous = toObjectArray(previous);
        }
        if (!(value instanceof Object[])) {
            value = toObjectArray(value);
        }
        // If values are still not of the type Object[], it is perhaps a
        // mistake by the renderers, so return false, so that
        // ValueChangedEvent is not queued in this case.
        if (!(previous instanceof Object[]) || 
              !(value instanceof Object[])) {
              return false;
        }
        oldarray = (Object[]) previous;
        newarray = (Object[])value;
       
        // If we got here then both the arrays cannot be null
        // if their lengths vary, return false.
        if ( oldarray.length != newarray.length) {
            return true;
        }
        
        // make sure every element in the previous array occurs the same
        // number of times in the current array. This should help us
        // to find out the values changed are not. Since we cannot assume
        // the browser will send the elements in the same order everytime,
        // it will not suffice to just compare the element position and position.
        int count1;
        int count2;
        for ( int i= 0; i < oldarray.length; ++i ) {
            count1 = countElementOccurrence(oldarray[i], oldarray);
            count2 = countElementOccurrence(oldarray[i], newarray);
            if ( count1 != count2 ) {
                valueChanged = true;
                break;
            }     
        }    
        return valueChanged;
    }    

    
    

Return the number of occurrances of a particular element in the array.

Parameters:
element object whose occurrance is to be counted in the array.
array object representing the old value of this component.
    private static int countElementOccurrence(Object elementObject[] array) {
        int count = 0;
        for ( int i= 0; i < array.length; ++i ) {
            Object arrayElement = array[i];
            if (arrayElement != null && element != null) {
                if (arrayElement.equals(element)) {
                    count ++;
                }
            }
        }    
        return count;
    }    

    
    
Convert an array of primitives to an array of boxed objects.

Parameters:
primitiveArray object containing the primitive values
Returns:
an Object array, or null if the incoming value is not in fact an array at all.
    private static Object[] toObjectArray(Object primitiveArray) {
        if (primitiveArray == null) {
            throw new NullPointerException();
        }
        
        if (primitiveArray instanceof Object[]) {
            return (Object[]) primitiveArray;
        }
        if (primitiveArray instanceof List) {
            return ((ListprimitiveArray).toArray();
        }
          
        Class clazz = primitiveArray.getClass();
        if (!clazz.isArray()) {
            return null;
        }
        int length = Array.getLength(primitiveArray);
        Object[] array = new Object[length];
        for (int i = 0; i < lengthi++) {
            array[i] = Array.get(primitiveArrayi);
        }
        return array;
    }
    // ------------------------------------------------------ Validation Methods

    

    

In addition to the standard validation behavior inherited from UIInput, ensure that any specified values are equal to one of the available options. Before comparing each option, coerce the option value type to the type of this component's value following the Expression Language coercion rules. If the specified value is not equal to any of the options, enqueue an error message and set the valid property to false.

Parameters:
context The javax.faces.context.FacesContext for the current request
value The converted value to test for membership.
Throws:
java.lang.NullPointerException if context is null
    protected void validateValue(FacesContext contextObject value) {
        super.validateValue(contextvalue);
        // Skip validation if it is not necessary
        if (!isValid() || (value == null)) {
            return;
        }
        // Ensure that the values match one of the available options
        // Don't arrays cast to "Object[]", as we may now be using an array
        // of primitives
        boolean isList = (value instanceof List);
        int length = isList ? ((Listvalue).size() : Array.getLength(value);
        boolean found = true;
        for (int i = 0; i < lengthi++) {
            Iterator items = new SelectItemsIterator(this);
            Object indexValue = isList ?
                ((Listvalue).get(i) : Array.get(valuei);
            found = matchValue(indexValueitems);
            if (!found) {
                break;
            }
        }
        // Enqueue an error message if an invalid value was specified
        if (!found) {
            FacesMessage message =
                MessageFactory.getMessage(context,
                     MessageFactory.getLabel(contextthis));
            context.addMessage(getClientId(context), message);
            setValid(false);
        }
    }
    // --------------------------------------------------------- Private Methods


    

Return true if the specified value matches one of the available options, performing a recursive search if if a javax.faces.model.SelectItemGroup instance is detected.

Parameters:
value UIComponent value to be tested
items Iterator over the javax.faces.model.SelectItems to be checked
    private boolean matchValue(Object valueIterator items) {
        while (items.hasNext()) {
            SelectItem item = (SelectItemitems.next();
            if (item instanceof SelectItemGroup) {
                SelectItem subitems[] =
                    ((SelectItemGroupitem).getSelectItems();
                if ((subitems != null) && (subitems.length > 0)) {
                    if (matchValue(valuenew ArrayIterator(subitems))) {
                        return (true);
                    }
                }
            } else {
                //Coerce the item value type before comparing values.
                Class type = value.getClass();
                Object newValue;
                try {
                    newValue = getFacesContext().getApplication().
                        getExpressionFactory().coerceToType(item.getValue(), type);
                } catch (ELException ele) {
                    newValue = item.getValue();
                } catch (IllegalArgumentException iae) {
                    // If coerceToType fails, per the docs it should throw
                    // an ELException, however, GF 9.0 and 9.0u1 will throw
                    // an IllegalArgumentException instead (see GF issue 1527).
                    newValue = item.getValue();
                }
                
                if (value.equals(newValue)) {
                    return (true);
                }
            }
        }
        return (false);
    }
    static class ArrayIterator implements Iterator {
        public ArrayIterator(Object items[]) {
            this. = items;
        }
        private Object items[];
        private int index = 0;
        public boolean hasNext() {
            return ( < .);
        }
        public Object next() {
            try {
                return ([++]);
            } catch (IndexOutOfBoundsException e) {
                throw new NoSuchElementException();
            }
        }
        public void remove() {
            throw new UnsupportedOperationException();
        }
    }
New to GrepCode? Check out our FAQ X