Clover coverage report - Code Coverage for tapestry release 4.0.3
Coverage timestamp: Fri May 5 2006 21:17:42 CDT
Overview   Package   File
    FRAMES   NO FRAMES  
file stats: LOC: 184   Methods: 9
NCLOC: 83   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
AbstractFormComponent.java 100% 96.6% 88.9% 96.3%
coverage coverage
 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 org.apache.tapestry.AbstractComponent;
 18    import org.apache.tapestry.IForm;
 19    import org.apache.tapestry.IMarkupWriter;
 20    import org.apache.tapestry.IRequestCycle;
 21    import org.apache.tapestry.TapestryUtils;
 22    import org.apache.tapestry.valid.IValidationDelegate;
 23    import org.apache.tapestry.valid.ValidationConstants;
 24   
 25    /**
 26    * A base class for building components that correspond to HTML form elements. All such components
 27    * must be wrapped (directly or indirectly) by a {@link Form} component.
 28    *
 29    * @author Howard Lewis Ship
 30    * @author Paul Ferraro
 31    * @since 1.0.3
 32    */
 33    public abstract class AbstractFormComponent extends AbstractComponent implements IFormComponent
 34    {
 35    public abstract IForm getForm();
 36   
 37    public abstract void setForm(IForm form);
 38   
 39    public abstract String getName();
 40   
 41    public abstract void setName(String name);
 42   
 43    /**
 44    * Returns true if the corresponding field, on the client side, can accept user focus (i.e.,
 45    * implements the focus() method). Most components can take focus (if not disabled), but a few ({@link Hidden})
 46    * override this method to always return false.
 47    */
 48   
 49  120 protected boolean getCanTakeFocus()
 50    {
 51  120 return !isDisabled();
 52    }
 53   
 54    /**
 55    * Should be connected to a parameter named "id" (annotations would be helpful here!). For
 56    * components w/o such a parameter, this will simply return null.
 57    */
 58   
 59    public abstract String getIdParameter();
 60   
 61    /**
 62    * Stores the actual id allocated (or null if the component doesn't support this).
 63    */
 64   
 65    public abstract void setClientId(String id);
 66   
 67    /**
 68    * Invoked from {@link #renderFormComponent(IMarkupWriter, IRequestCycle)} (that is, an
 69    * implementation in a subclass), to obtain an id and render an id attribute. Reads
 70    * {@link #getIdParameter()}.
 71    */
 72   
 73  123 protected void renderIdAttribute(IMarkupWriter writer, IRequestCycle cycle)
 74    {
 75    // If the user explicitly sets the id parameter to null, then
 76    // we honor that!
 77   
 78  123 String rawId = getIdParameter();
 79   
 80  123 if (rawId == null)
 81  75 return;
 82   
 83  48 String id = cycle.getUniqueId(TapestryUtils.convertTapestryIdToNMToken(rawId));
 84   
 85    // Store for later access by the FieldLabel (or JavaScript).
 86   
 87  48 setClientId(id);
 88   
 89  48 writer.attribute("id", id);
 90    }
 91   
 92    /**
 93    * @see org.apache.tapestry.AbstractComponent#renderComponent(org.apache.tapestry.IMarkupWriter,
 94    * org.apache.tapestry.IRequestCycle)
 95    */
 96  366 protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
 97    {
 98  366 IForm form = TapestryUtils.getForm(cycle, this);
 99   
 100  363 setForm(form);
 101   
 102  363 if (form.wasPrerendered(writer, this))
 103  15 return;
 104   
 105  348 IValidationDelegate delegate = form.getDelegate();
 106   
 107  348 delegate.setFormComponent(this);
 108   
 109  348 setName(form);
 110   
 111  345 if (form.isRewinding())
 112    {
 113  147 if (!isDisabled())
 114  126 rewindFormComponent(writer, cycle);
 115   
 116    // This is for the benefit of the couple of components (LinkSubmit and RadioGroup) that allow a body.
 117  21 else if (getAlwaysRenderBodyOnRewind())
 118  3 renderBody(writer, cycle);
 119    }
 120  198 else if (!cycle.isRewinding())
 121    {
 122  177 renderFormComponent(writer, cycle);
 123   
 124  171 if (getCanTakeFocus() && !isDisabled())
 125    {
 126  93 delegate.registerForFocus(
 127    this,
 128  93 delegate.isInError() ? ValidationConstants.ERROR_FIELD
 129    : ValidationConstants.NORMAL_FIELD);
 130    }
 131   
 132    }
 133    }
 134   
 135    /**
 136    * A small number of components should always render their body on rewind (even if the component
 137    * is itself disabled) and should override this method to return true. Components that
 138    * explicitly render their body inside
 139    * {@link #rewindFormComponent(IMarkupWriter, IRequestCycle)} should leave this method returning
 140    * false. Remember that if the component is {@link IFormComponent#isDisabled() disabled} then
 141    * {@link #rewindFormComponent(IMarkupWriter, IRequestCycle)} won't be invoked.
 142    *
 143    * @return false; override this method to change.
 144    */
 145  18 protected boolean getAlwaysRenderBodyOnRewind()
 146    {
 147  18 return false;
 148    }
 149   
 150  66 protected void renderDelegatePrefix(IMarkupWriter writer, IRequestCycle cycle)
 151    {
 152  66 getForm().getDelegate().writePrefix(writer, cycle, this, null);
 153    }
 154   
 155  66 protected void renderDelegateAttributes(IMarkupWriter writer, IRequestCycle cycle)
 156    {
 157  66 getForm().getDelegate().writeAttributes(writer, cycle, this, null);
 158    }
 159   
 160  63 protected void renderDelegateSuffix(IMarkupWriter writer, IRequestCycle cycle)
 161    {
 162  63 getForm().getDelegate().writeSuffix(writer, cycle, this, null);
 163    }
 164   
 165  324 protected void setName(IForm form)
 166    {
 167  324 form.getElementId(this);
 168    }
 169   
 170    /**
 171    * Returns false. Subclasses that might be required must override this method. Typically, this
 172    * involves checking against the component's validators.
 173    *
 174    * @since 4.0
 175    */
 176  0 public boolean isRequired()
 177    {
 178  0 return false;
 179    }
 180   
 181    protected abstract void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle);
 182   
 183    protected abstract void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle);
 184    }
 
CloverReport generated by Clover Code Coverage v1.3.12
Fri May 5 2006 21:21:31 CDT.		   Open Source License registered to the Apache Software Foundation. This license of Clover is provided to support projects of the Apache Software Foundation only.