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 org.apache.myfaces.orchestra.dynaForm.annot.ui;
20  
21  import org.apache.myfaces.orchestra.dynaForm.metadata.FieldRepresentation;
22  
23  import java.lang.annotation.ElementType;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  /**
29   * Specify how this particular property is to be rendered.
30   * <p>
31   * For some JSF components there may be multiple ways of presenting the
32   * data to the user (ie there may be a choice of component <i>renderers</i>).
33   * This annotation allows the renderer type to be selected.
34   * <p>
35   * TODO: is this really flexible enough? The enum here is hard-wiring the
36   * possibilities, but a user's custom component might also have alternate
37   * renderers. Maybe just a component-type string should be specified here,
38   * with the Dynaform doing a normal factory-lookup to get the appropriate
39   * component type?
40   * <p>
41   * Note also that this is very JSF-specific.
42   */
43  @Target(value = {ElementType.METHOD, ElementType.FIELD})
44  @Retention(value = RetentionPolicy.RUNTIME)
45  public @interface UIComponent
46  {
47      FieldRepresentation type() default FieldRepresentation.OutputText;
48  }