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.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
23  import org.apache.myfaces.tobago.apt.annotation.Facet;
24  import org.apache.myfaces.tobago.apt.annotation.Tag;
25  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
27  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
28  import org.apache.myfaces.tobago.component.Facets;
29  import org.apache.myfaces.tobago.component.RendererTypes;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverter;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasId;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelAndAccessKey;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDeprecatedInline;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
37  import org.apache.myfaces.tobago.internal.taglib.declaration.IsReadonly;
38  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered;
39  
40  import javax.faces.component.UISelectOne;
41  
42  /**
43   * Render a single selection dropdown list.
44   */
45  @Tag(name = "selectOneChoice")
46  @BodyContentDescription(anyTagOf = "(<f:selectItems>|<f:selectItem>|<tc:selectItem>)+ <f:facet>* ")
47  @UIComponentTag(
48      uiComponent = "org.apache.myfaces.tobago.component.UISelectOneChoice",
49      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUISelectOneChoice",
50      uiComponentFacesClass = "javax.faces.component.UISelectOne",
51      componentFamily = UISelectOne.COMPONENT_FAMILY,
52      rendererType = RendererTypes.SELECT_ONE_CHOICE,
53      allowedChildComponenents = {
54          "javax.faces.SelectItem",
55          "javax.faces.SelectItems"
56          },
57      facets = {
58      @Facet(name= Facets.CLICK,
59          description =
60              "This facet can contain a UICommand that is invoked in case of a click event from the component",
61          allowedChildComponenents = "org.apache.myfaces.tobago.Command"),
62      @Facet(name=Facets.CHANGE,
63          description =
64              "This facet can contain a UICommand that is invoked in case of a change event from the component",
65          allowedChildComponenents = "org.apache.myfaces.tobago.Command")
66          })
67  public interface SelectOneChoiceTagDeclaration
68      extends SelectOneTagDeclaration, HasId, IsDisabled,
69      IsReadonly, IsDeprecatedInline, HasLabelAndAccessKey,
70      IsRendered, HasConverter, HasBinding, HasTip {
71  
72    /**
73     * Flag indicating that selecting an Item representing a value is required.
74     * If an SelectItem was chosen which underling value is an empty string an
75     * ValidationError occurs and a Error Message is rendered.
76     */
77    @TagAttribute()
78    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
79    void setRequired(String required);
80  }