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  
20  package org.apache.myfaces.tobago.apt.annotation;
21  
22  import java.lang.annotation.Retention;
23  import java.lang.annotation.RetentionPolicy;
24  import java.lang.annotation.Target;
25  import java.lang.annotation.ElementType;
26  
27  @Retention(value = RetentionPolicy.SOURCE)
28  @Target(value = ElementType.TYPE)
29  
30  public @interface UIComponentTag {
31  
32    String uiComponent();
33  
34    String uiComponentBaseClass() default "javax.faces.component.UIComponentBase";
35  
36    String uiComponentFacesClass() default "javax.faces.component.UIComponentBase";
37  
38    String componentType() default "";
39  
40    String componentFamily() default "";
41  
42    String rendererType() default "";
43  
44    String faceletHandler() default "org.apache.myfaces.tobago.facelets.TobagoComponentHandler";
45  
46    String displayName() default "";
47  
48    boolean isLayout() default false;
49  
50    boolean isTransparentForLayout() default false;
51  
52    String[] interfaces() default {};
53  
54    Facet[] facets() default {};
55  
56    boolean generate() default true;
57  
58    boolean isComponentAlreadyDefined() default false;
59  
60    /**
61     * Array of supported component-types that explictly enumerates the
62     * set of allowd component children for this component. Other possible values are: ALL...
63     * @return
64     */
65    String [] allowedChildComponenents() default { "ALL" };
66  
67    /**
68     * Specifies the category of a component palette.
69     * @return
70     */
71    Category category() default Category.GENERAL;
72  
73    /**
74     * Specifies whether this component should be available on a component palette.
75     * @return
76     */
77    boolean isHidden() default false;
78  
79  
80  }