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.Behavior;
23  import org.apache.myfaces.tobago.apt.annotation.BodyContentDescription;
24  import org.apache.myfaces.tobago.apt.annotation.Markup;
25  import org.apache.myfaces.tobago.apt.annotation.Tag;
26  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
27  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
28  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
29  import org.apache.myfaces.tobago.component.ClientBehaviors;
30  import org.apache.myfaces.tobago.component.RendererTypes;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverter;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverterMessage;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasHelp;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.HasId;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
37  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelLayout;
38  import org.apache.myfaces.tobago.internal.taglib.declaration.HasRequiredMessage;
39  import org.apache.myfaces.tobago.internal.taglib.declaration.HasSize;
40  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
41  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
42  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidator;
43  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidatorMessage;
44  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
45  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValueChangeListener;
46  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
47  import org.apache.myfaces.tobago.internal.taglib.declaration.IsFocus;
48  import org.apache.myfaces.tobago.internal.taglib.declaration.IsReadonly;
49  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRendered;
50  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
51  
52  import javax.faces.component.UISelectOne;
53  
54  /**
55   * Render a single selection option listbox.
56   */
57  @Tag(name = "selectOneListbox")
58  @BodyContentDescription(anyTagOf = "(<f:selectItems>|<f:selectItem>|<tc:selectItem>)+ <f:facet>* ")
59  @UIComponentTag(
60      uiComponent = "org.apache.myfaces.tobago.component.UISelectOneListbox",
61      uiComponentFacesClass = "javax.faces.component.UISelectOne",
62      componentFamily = UISelectOne.COMPONENT_FAMILY,
63      rendererType = RendererTypes.SELECT_ONE_LISTBOX,
64      allowedChildComponenents = {
65          "javax.faces.SelectItem",
66          "javax.faces.SelectItems"
67          },
68      behaviors = {
69          @Behavior(
70              name = ClientBehaviors.CHANGE,
71              isDefault = true),
72          @Behavior(
73              name = ClientBehaviors.CLICK),
74          @Behavior(
75              name = ClientBehaviors.DBLCLICK),
76          @Behavior(
77              name = ClientBehaviors.FOCUS),
78          @Behavior(
79              name = ClientBehaviors.BLUR)
80      },
81      markups = {
82          @Markup(
83              name = org.apache.myfaces.tobago.context.Markup.STRING_SPREAD,
84              description = "Use the full height for the HTML content."
85          )
86      })
87  public interface SelectOneListboxTagDeclaration
88      extends HasValidator, HasValue, HasValueChangeListener, HasTabIndex, IsFocus, IsVisual,
89      HasValidatorMessage, HasConverterMessage, HasRequiredMessage, HasId, IsDisabled, IsReadonly, HasLabel, IsRendered,
90      HasBinding, HasTip, HasHelp, HasConverter, HasLabelLayout, HasSize {
91  
92    /**
93     * Flag indicating that selecting an Item representing a Value is Required.
94     * If an SelectItem was chosen which underling value is an empty string an
95     * ValidationError occurs and a Error Message is rendered.
96     */
97    @TagAttribute()
98    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
99    void setRequired(String required);
100 }