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