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