Coverage Report - org.apache.tapestry.form.Select
 
Classes in this File Line Coverage Branch Coverage Complexity
Select
0% 
0% 
2.182
 
 1  
 // Copyright 2004, 2005 The Apache Software Foundation
 2  
 //
 3  
 // Licensed under the Apache License, Version 2.0 (the "License");
 4  
 // you may not use this file except in compliance with the License.
 5  
 // You may obtain a copy of the License at
 6  
 //
 7  
 //     http://www.apache.org/licenses/LICENSE-2.0
 8  
 //
 9  
 // Unless required by applicable law or agreed to in writing, software
 10  
 // distributed under the License is distributed on an "AS IS" BASIS,
 11  
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12  
 // See the License for the specific language governing permissions and
 13  
 // limitations under the License.
 14  
 
 15  
 package org.apache.tapestry.form;
 16  
 
 17  
 import java.util.HashSet;
 18  
 import java.util.Set;
 19  
 
 20  
 import org.apache.hivemind.ApplicationRuntimeException;
 21  
 import org.apache.tapestry.IMarkupWriter;
 22  
 import org.apache.tapestry.IRequestCycle;
 23  
 import org.apache.tapestry.Tapestry;
 24  
 import org.apache.tapestry.valid.ValidatorException;
 25  
 
 26  
 /**
 27  
  * Implements a component that manages an HTML <select> form element. The most common
 28  
  * situation, using a <select> to set a specific property of some object, is best handled
 29  
  * using a {@link PropertySelection}component. [ <a
 30  
  * href="../../../../../ComponentReference/Select.html">Component Reference </a>]
 31  
  * <p>
 32  
  * Otherwise, this component is very similar to {@link RadioGroup}. 
 33  
  * <p>
 34  
  * As of 4.0, this component can be validated.
 35  
  * 
 36  
  * @author Howard Lewis Ship
 37  
  * @author Paul Ferraro
 38  
  */
 39  0
 public abstract class Select extends AbstractFormComponent implements ValidatableField
 40  
 {
 41  
     
 42  
     /**
 43  
      * Used by the <code>Select</code> to record itself as a {@link IRequestCycle}attribute, so
 44  
      * that the {@link Option}components it wraps can have access to it.
 45  
      */
 46  
 
 47  
     private static final String ATTRIBUTE_NAME = "org.apache.tapestry.active.Select";
 48  
     
 49  
     private boolean _rewinding;
 50  
 
 51  
     private boolean _rendering;
 52  
 
 53  
     private Set _selections;
 54  
 
 55  
     private int _nextOptionId;
 56  
 
 57  
     public static Select get(IRequestCycle cycle)
 58  
     {
 59  0
         return (Select) cycle.getAttribute(ATTRIBUTE_NAME);
 60  
     }
 61  
 
 62  
     public abstract boolean isMultiple();
 63  
 
 64  
     public boolean isRewinding()
 65  
     {
 66  0
         if (!_rendering)
 67  0
             throw Tapestry.createRenderOnlyPropertyException(this, "rewinding");
 68  
 
 69  0
         return _rewinding;
 70  
     }
 71  
 
 72  
     public String getNextOptionId()
 73  
     {
 74  0
         if (!_rendering)
 75  0
             throw Tapestry.createRenderOnlyPropertyException(this, "nextOptionId");
 76  
 
 77  
         // Return it as a hex value.
 78  
 
 79  0
         return Integer.toString(_nextOptionId++);
 80  
     }
 81  
 
 82  
     public boolean isSelected(String value)
 83  
     {
 84  0
         if (_selections == null)
 85  0
             return false;
 86  
 
 87  0
         return _selections.contains(value);
 88  
     }
 89  
 
 90  
     /**
 91  
      * @see org.apache.tapestry.AbstractComponent#prepareForRender(org.apache.tapestry.IRequestCycle)
 92  
      */
 93  
     protected void prepareForRender(IRequestCycle cycle)
 94  
     {
 95  0
         if (cycle.getAttribute(ATTRIBUTE_NAME) != null)
 96  0
             throw new ApplicationRuntimeException(Tapestry.getMessage("Select.may-not-nest"), this,
 97  
                     null, null);
 98  
 
 99  0
         cycle.setAttribute(ATTRIBUTE_NAME, this);
 100  
 
 101  0
         _rendering = true;
 102  0
         _nextOptionId = 0;      
 103  0
     }
 104  
 
 105  
     /**
 106  
      * @see org.apache.tapestry.AbstractComponent#cleanupAfterRender(org.apache.tapestry.IRequestCycle)
 107  
      */
 108  
     protected void cleanupAfterRender(IRequestCycle cycle)
 109  
     {
 110  0
         _rendering = false;
 111  0
         _selections = null;        
 112  
         
 113  0
         cycle.removeAttribute(ATTRIBUTE_NAME);           
 114  0
     }
 115  
 
 116  
     /**
 117  
      * @see org.apache.tapestry.form.AbstractFormComponent#renderFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)
 118  
      */
 119  
     protected void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
 120  
     {
 121  0
         _rewinding = false;
 122  
 
 123  0
         renderDelegatePrefix(writer, cycle);
 124  
 
 125  0
         writer.begin("select");
 126  
 
 127  0
         writer.attribute("name", getName());
 128  
 
 129  0
         if (isMultiple())
 130  0
             writer.attribute("multiple", "multiple");
 131  
 
 132  0
         if (isDisabled())
 133  0
             writer.attribute("disabled", "disabled");
 134  
 
 135  0
         renderIdAttribute(writer, cycle);
 136  
 
 137  0
         renderDelegateAttributes(writer, cycle);
 138  
 
 139  0
         getValidatableFieldSupport().renderContributions(this, writer, cycle);
 140  
         
 141  0
         renderInformalParameters(writer, cycle);
 142  
 
 143  0
         renderBody(writer, cycle);
 144  
 
 145  0
         writer.end();
 146  
 
 147  0
         renderDelegateSuffix(writer, cycle);
 148  0
     }
 149  
 
 150  
     /**
 151  
      * @see org.apache.tapestry.form.AbstractFormComponent#rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)
 152  
      */
 153  
     protected void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle)
 154  
     {
 155  0
         _selections = null;
 156  0
         _rewinding = true;
 157  
 
 158  0
         String[] parameters = cycle.getParameters(getName());
 159  
 
 160  
         try
 161  
         {
 162  0
             if (parameters != null)
 163  
             {
 164  0
                 int length = parameters.length;
 165  
     
 166  0
                 _selections = new HashSet((length > 30) ? 101 : 7);
 167  
     
 168  0
                 for (int i = 0; i < length; i++)
 169  0
                     _selections.add(parameters[i]);
 170  
             }
 171  
     
 172  0
             renderBody(writer, cycle);
 173  
             
 174  
             // This is atypical validation - since this component does not explicitly bind to an object
 175  0
             getValidatableFieldSupport().validate(this, writer, cycle, parameters);
 176  
         }
 177  0
         catch (ValidatorException e)
 178  
         {
 179  0
             getForm().getDelegate().record(e);
 180  0
         }
 181  0
     }
 182  
 
 183  
     /**
 184  
      * Injected.
 185  
      */
 186  
     public abstract ValidatableFieldSupport getValidatableFieldSupport();
 187  
 
 188  
     /**
 189  
      * @see org.apache.tapestry.form.AbstractFormComponent#isRequired()
 190  
      */
 191  
     public boolean isRequired()
 192  
     {
 193  0
         return getValidatableFieldSupport().isRequired(this);
 194  
     }
 195  
 }