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 java.lang.annotation.ElementType;
22 import java.lang.annotation.Inherited;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26
27 @Target(value=ElementType.TYPE)
28 @Retention(value=RetentionPolicy.RUNTIME)
29 @Inherited
30 public @interface FacesRenderer
31 {
32 /**
33 * The value of this annotation attribute is taken to be the <i>component-family</i> which, in combination with
34 * {@link #rendererType()} can be used to obtain a reference to an instance of this {@link Renderer} by calling
35 * {@link RenderKit#getRenderer(java.lang.String, java.lang.String)}.
36 */
37 public String componentFamily();
38
39 /**
40 * The value of this annotation attribute is taken to be the <i>renderer-type</i> which, in combination with
41 * {@link #componentFamily()} can be used to obtain a reference to an instance of this {@link Renderer} by calling
42 * {@link RenderKit#getRenderer(java.lang.String, java.lang.String)}.
43 */
44 public String rendererType();
45
46 /**
47 * The value of this annotation attribute is taken to be the <i>render-kit-id</i> in which an instance of this class
48 * of {@link Renderer} must be installed.
49 */
50 public String renderKitId() default RenderKitFactory.HTML_BASIC_RENDER_KIT;
51 }