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.DynamicExpression;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
27  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBinding;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasId;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasItemLabel;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
31  
32  /**
33   * Add a child UISelectItem component to the UIComponent
34   * associated with the closed parent UIComponent custom
35   * action.
36   */
37  @Tag(name = "selectItem")
38  @UIComponentTag(
39      uiComponent = "org.apache.myfaces.tobago.component.UISelectItem",
40      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUISelectItem",
41      uiComponentFacesClass = "javax.faces.component.UISelectItem",
42      allowedChildComponenents = "NONE")
43  public interface SelectItemTagDeclaration extends HasBinding, HasId, IsVisual, HasItemLabel {
44  
45    /**
46     * Description of an item, might be rendered as a tool tip.
47     * @deprecated since 2.0.0, please use itemTip.
48     */
49    @Deprecated
50    @TagAttribute
51    @UIComponentTagAttribute(type = {"java.lang.String"})
52    void setItemDescription(String itemDescription);
53  
54    /**
55     * Flag indicating whether the option created
56     * by this component is disabled.
57     */
58    @TagAttribute
59    @UIComponentTagAttribute(type = {"boolean"}, defaultValue = "false")
60    void setItemDisabled(String itemDisabled);
61  
62    /**
63     * Value to be returned to the server if this option is selected by the user.
64     */
65    @TagAttribute
66    @UIComponentTagAttribute()
67    void setItemValue(String itemValue);
68  
69    /**
70     * Value binding expression pointing at a SelectItem instance containing
71     * the information for this option.
72     */
73    @TagAttribute
74    @UIComponentTagAttribute(
75        type = "javax.faces.model.SelectItem",
76        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
77    void setValue(String value);
78  
79    /**
80     * Image to be displayed to the user for this option.
81     */
82    @TagAttribute
83    @UIComponentTagAttribute()
84    void setItemImage(String itemImage);
85  
86    /**
87     * Text value to display as tooltip.
88     */
89    @TagAttribute
90    @UIComponentTagAttribute()
91    void setTip(String tip);
92  }