Clover coverage report - Code Coverage for tapestry release 4.0.2
Coverage timestamp: Thu Apr 13 2006 10:52:06 EDT
file stats: LOC: 80   Methods: 0
NCLOC: 10   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
FormSupport.java - - - -
coverage
 1    // Copyright 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.FormBehavior;
 18    import org.apache.tapestry.IRender;
 19    import org.apache.tapestry.engine.ILink;
 20   
 21    /**
 22    * Interface for a utility object that encapsulates the majority of the
 23    * {@link org.apache.tapestry.form.Form}'s behavior.
 24    *
 25    * @author Howard M. Lewis Ship
 26    * @since 4.0
 27    */
 28    public interface FormSupport extends FormBehavior
 29    {
 30   
 31    /**
 32    * Invoked when the form is rendering. This should only be invoked by the {@link Form}
 33    * component.
 34    *
 35    * @param method
 36    * the HTTP method ("get" or "post")
 37    * @param informalParametersRenderer
 38    * object that will render informal parameters
 39    * @param link
 40    * The link to which the form will submit (encapsulating the URL and the query
 41    * parameters)
 42    * @param scheme
 43    * the desired scheme for the generated URL, typically "http" or "https". If
 44    * non-null, and the scheme does not match the current request's scheme, then an
 45    * absolute URL with the specified scheme will be generated, rather than a URI.
 46    * @param port
 47    * the desired port for the generated URL, typically "80", "443". If
 48    * non-null, and the port does not match the current request's port, then an
 49    * absolute URL with the specified port will be generated, rather than a URI.
 50    */
 51    public void render(String method, IRender informalParametersRenderer, ILink link, String scheme, Integer port);
 52   
 53    /**
 54    * Old interface left around for backwards compatibility. Please use the second render method.
 55    *
 56    * @param method
 57    * the HTTP method ("get" or "post")
 58    * @param informalParametersRenderer
 59    * object that will render informal parameters
 60    * @param link
 61    * The link to which the form will submit (encapsulating the URL and the query
 62    * parameters)
 63    * @param scheme
 64    * the desired scheme for the generated URL, typically "http" or "https". If
 65    * non-null, and the scheme does not match the current request's scheme, then an
 66    * absolute URL with the specified scheme will be generated, rather than a URI.
 67    * @deprecated To be removed in 4.1, see new render method that adds the Port parameter.
 68    */
 69    public void render(String method, IRender informalParametersRenderer, ILink link, String scheme);
 70   
 71    /**
 72    * Invoked to rewind the form, which renders the body of the form, allowing form element
 73    * components to pull data from the request and update page properties. This should only be
 74    * invoked by the {@link Form} component.
 75    *
 76    * @return a code indicating why the form was submitted: {@link FormConstants#SUBMIT_NORMAL},
 77    * {@link FormConstants#SUBMIT_CANCEL} or {@link FormConstants#SUBMIT_REFRESH}.
 78    */
 79    public String rewind();
 80    }