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