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