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: 197   Methods: 9
NCLOC: 66   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Body.java - 86.4% 66.7% 80.6%
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.html;
 16   
 17    import org.apache.hivemind.Resource;
 18    import org.apache.tapestry.AbstractComponent;
 19    import org.apache.tapestry.IMarkupWriter;
 20    import org.apache.tapestry.IRequestCycle;
 21    import org.apache.tapestry.PageRenderSupport;
 22    import org.apache.tapestry.TapestryUtils;
 23    import org.apache.tapestry.asset.AssetFactory;
 24    import org.apache.tapestry.util.PageRenderSupportImpl;
 25    import org.apache.tapestry.web.WebResponse;
 26   
 27    /**
 28    * The body of a Tapestry page. This is used since it allows components on the page access to an
 29    * initialization script (that is written the start, just inside the <body> tag). This is
 30    * currently used by {@link Rollover}and {@link Script}components. [ <a
 31    * href="../../../../../ComponentReference/Body.html">Component Reference </a>]
 32    *
 33    * @author Howard Lewis Ship
 34    */
 35   
 36    public abstract class Body extends AbstractComponent implements PageRenderSupport
 37    {
 38    private PageRenderSupportImpl _pageRenderSupport;
 39   
 40    /**
 41    * Adds to the script an initialization for the named variable as an Image(), to the given URL.
 42    * <p>
 43    * Returns a reference, a string that can be used to represent the preloaded image in a
 44    * JavaScript function.
 45    *
 46    * @since 1.0.2
 47    */
 48   
 49  0 public String getPreloadedImageReference(String URL)
 50    {
 51  0 return _pageRenderSupport.getPreloadedImageReference(URL);
 52    }
 53   
 54    /**
 55    * Adds other initialization, in the form of additional JavaScript code to execute from the
 56    * &lt;body&gt;'s <code>onLoad</code> event handler. The caller is responsible for adding a
 57    * semicolon (statement terminator). This method will add a newline after the script.
 58    */
 59   
 60  141 public void addInitializationScript(String script)
 61    {
 62  141 _pageRenderSupport.addInitializationScript(script);
 63    }
 64   
 65    /**
 66    * Adds additional scripting code to the page. This code will be added to a large block of
 67    * scripting code at the top of the page (i.e., the before the &lt;body&gt; tag).
 68    * <p>
 69    * This is typically used to add some form of JavaScript event handler to a page. For example,
 70    * the {@link Rollover}component makes use of this.
 71    * <p>
 72    * Another way this is invoked is by using the {@link Script}component.
 73    * <p>
 74    * The string will be added, as-is, within the &lt;script&gt; block generated by this
 75    * <code>Body</code> component. The script should <em>not</em> contain HTML comments, those
 76    * will be supplied by this Body component.
 77    * <p>
 78    * A frequent use is to add an initialization function using this method, then cause it to be
 79    * executed using {@link #addInitializationScript(String)}.
 80    */
 81   
 82  0 public void addBodyScript(String script)
 83    {
 84  0 _pageRenderSupport.addBodyScript(script);
 85    }
 86   
 87    /**
 88    * Used to include a script from an outside URL (the scriptLocation is a URL, probably obtained
 89    * from an asset. This adds an &lt;script src="..."&gt; tag before the main &lt;script&gt; tag.
 90    * The Body component ensures that each URL is included only once.
 91    *
 92    * @since 1.0.5
 93    */
 94   
 95  117 public void addExternalScript(Resource scriptLocation)
 96    {
 97  117 _pageRenderSupport.addExternalScript(scriptLocation);
 98    }
 99   
 100    /**
 101    * Retrieves the <code>Body</code> that was stored into the request cycle. This allows
 102    * components wrapped by the <code>Body</code> to locate it and access the services it
 103    * provides.
 104    *
 105    * @param cycle Request cycle in which the Body was stored
 106    * @return Body wrapping the components for the specified request cycle
 107    *
 108    * @deprecated To be removed in 4.1. Use
 109    * {@link org.apache.tapestry.TapestryUtils#getOptionalPageRenderSupport(IRequestCycle)}
 110    * instead.
 111    */
 112   
 113  6 public static Body get(IRequestCycle cycle)
 114    {
 115  6 return (Body) TapestryUtils.getOptionalPageRenderSupport(cycle);
 116    }
 117   
 118  207 protected void prepareForRender(IRequestCycle cycle)
 119    {
 120  207 super.prepareForRender(cycle);
 121   
 122  207 _pageRenderSupport = new PageRenderSupportImpl(getAssetFactory(), getResponse()
 123    .getNamespace(), getLocation());
 124    }
 125   
 126  207 protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
 127    {
 128  207 TapestryUtils.storePageRenderSupport(cycle, this);
 129   
 130  207 IMarkupWriter nested = writer.getNestedWriter();
 131   
 132  207 renderBody(nested, cycle);
 133   
 134    // Start the body tag.
 135  189 writer.println();
 136  189 writer.begin(getElement());
 137  189 renderInformalParameters(writer, cycle);
 138   
 139  189 writer.println();
 140   
 141    // Write the page's scripting. This is included scripts
 142    // and dynamic JavaScript.
 143   
 144  189 _pageRenderSupport.writeBodyScript(writer, cycle);
 145   
 146    // Close the nested writer, which dumps its buffered content
 147    // into its parent.
 148   
 149  189 nested.close();
 150   
 151    // Any initialization should go at the very end of the document
 152    // just before the close body tag. Older version of Tapestry
 153    // would create a window.onload event handler, but this is better
 154    // (it doesn't have to wait for external images to load).
 155   
 156  189 _pageRenderSupport.writeInitializationScript(writer);
 157   
 158  189 writer.end(); // <body>
 159    }
 160   
 161  207 protected void cleanupAfterRender(IRequestCycle cycle)
 162    {
 163  207 super.cleanupAfterRender(cycle);
 164   
 165  207 _pageRenderSupport = null;
 166   
 167  207 TapestryUtils.removePageRenderSupport(cycle);
 168    }
 169   
 170    /**
 171    * Parameter.
 172    */
 173    public abstract String getElement();
 174   
 175    /**
 176    * Injected
 177    *
 178    * @since 4.0
 179    */
 180    public abstract AssetFactory getAssetFactory();
 181   
 182    /**
 183    * Injected
 184    *
 185    * @since 4.0
 186    */
 187   
 188    public abstract WebResponse getResponse();
 189   
 190    /** @since 3.0 */
 191   
 192  0 public String getUniqueString(String baseValue)
 193    {
 194  0 return _pageRenderSupport.getUniqueString(baseValue);
 195    }
 196   
 197    }
 
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.