View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.render;
20  
21  import javax.faces.FacesWrapper;
22  import javax.faces.context.FacesContext;
23  import java.util.Iterator;
24  
25  /**
26   * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
27   */
28  public abstract class RenderKitFactory implements
29          FacesWrapper<RenderKitFactory>
30  {
31      public static final String HTML_BASIC_RENDER_KIT = "HTML_BASIC";
32  
33      public abstract void addRenderKit(String renderKitId,
34                                        RenderKit renderKit);
35  
36      public abstract RenderKit getRenderKit(FacesContext context,
37                                             String renderKitId);
38  
39      public abstract Iterator<String> getRenderKitIds();
40      
41      /**
42       * If this factory has been decorated, the implementation doing the decorating may override this method to 
43       * provide access to the implementation being wrapped. A default implementation is provided that returns 
44       * <code>null</code>.
45       * 
46       * @return the decorated <code>RenderKitFactory</code> if this factory decorates another, 
47       *         or <code>null</code> otherwise
48       * 
49       * @since 2.0
50       */
51      public RenderKitFactory getWrapped()
52      {
53          return null;
54      }
55  }