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  package javax.faces.component.html;
20  
21  import javax.faces.component.UISelectOne;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
24  
25  /**
26   * Allow the user to choose one option from a set of options.
27   * <p>
28   * Renders a drop-down menu (aka "combo-box") containing a set of
29   * choices, of which only one can be chosen at a time. The available
30   * choices are defined via child f:selectItem or f:selectItems
31   * elements.
32   * </p>
33   * <p>
34   * The value attribute of this component is read to determine
35   * which of the available options is initially selected; its value
36   * should match the "value" property of one of the child SelectItem
37   * objects.
38   * </p>
39   * <p>
40   * On submit of the enclosing form, the value attribute's bound property
41   * is updated to contain the "value" property from the chosen SelectItem.
42   * </p>
43   *
44   */
45  @JSFComponent
46  (name = "h:selectOneMenu",
47  clazz = "javax.faces.component.html.HtmlSelectOneMenu",template=true,
48  tagClass = "org.apache.myfaces.taglib.html.HtmlSelectOneMenuTag",
49  defaultRendererType = "javax.faces.Menu"
50  )
51  abstract class _HtmlSelectOneMenu extends UISelectOne implements
52  _AccesskeyProperty, _UniversalProperties, _DisabledReadonlyProperties,
53  _FocusBlurProperties, _ChangeSelectProperties, _EventProperties,
54  _StyleProperties, _TabindexProperty, _DisabledClassEnabledClassProperties,
55  _LabelProperty
56  {
57  
58    static public final String COMPONENT_FAMILY =
59      "javax.faces.SelectOne";
60    static public final String COMPONENT_TYPE =
61      "javax.faces.HtmlSelectOneMenu";
62  
63  }