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