Coverage Report - org.apache.tapestry.form.FormComponentContributor
 
Classes in this File Line Coverage Branch Coverage Complexity
FormComponentContributor
N/A
N/A
1
 
 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.IMarkupWriter;
 18  
 import org.apache.tapestry.IRequestCycle;
 19  
 
 20  
 /**
 21  
  * Interface for objects that contribute client-side events back to a form.
 22  
  * 
 23  
  * @author Paul Ferraro
 24  
  * @since 4.0
 25  
  */
 26  
 public interface FormComponentContributor
 27  
 {
 28  
     /**
 29  
      * Invoked by a form component after it finishes rendering its tag (but before the tag is
 30  
      * closed) to allow this object to contribute to the component's rendering process. Typically
 31  
      * used by Validators and Translators to add javascript methods to the form's submit event
 32  
      * handler.
 33  
      * 
 34  
      * @param writer
 35  
      *            allows contributor to write additional attributes into the component's tag
 36  
      * @param cycle
 37  
      *            for accessing request information
 38  
      * @param context
 39  
      *            utilities for genering messages and client-side validation
 40  
      * @param field
 41  
      *            the field for which contributions are being rendered
 42  
      */
 43  
     void renderContribution(IMarkupWriter writer, IRequestCycle cycle,
 44  
             FormComponentContributorContext context, IFormComponent field);
 45  
 }