ITemplateSourceDelegate


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.engine;
16  
17  import java.util.Locale  ;
18  
19  import org.apache.tapestry.IComponent;
20  import org.apache.tapestry.IRequestCycle;
21  import org.apache.tapestry.parse.ComponentTemplate;
22  
23  /**
24   *  Acts as a delegate to the {@link org.apache.tapestry.services.TemplateSource}, 
25   *  providing access to page and component templates after the normal search mechanisms have failed.
26   * 
27   *  <p>
28   *  The delegate must be threadsafe.
29   *
30   *  @author Howard Lewis Ship
31   *  @since 3.0
32   *  @see org.apache.tapestry.services.impl.TemplateSourceImpl
33   * 
34   **/
35  
36  public interface ITemplateSourceDelegate
37  {
38      /**
39       *  Invoked by the {@link ITemplateSource} when a template can't be found
40       *  by normal means (i.e., in the normal locations).  This method
41       *  should find the template.  The result may be null.  The delegate
42       *  is responsible for caching the result.
43       * 
44       *  @param cycle for access to Tapestry and Servlet API objects
45       *  @param component component (or page) for which a template is needed
46       *  @param locale the desired locale for the template
47       * 
48       **/
49  
50      public ComponentTemplate findTemplate(IRequestCycle cycle, IComponent component, Locale   locale);
51  }
52
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags