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  
31  /**
32   * Add a child UISelectItems component to the UIComponent
33   * associated with the closed parent UIComponent custom
34   * action.
35   */
36  @Tag(name = "selectItems")
37  @UIComponentTag(
38      uiComponent = "org.apache.myfaces.tobago.component.UISelectItems",
39      uiComponentBaseClass = "javax.faces.component.UISelectItems",
40      uiComponentFacesClass = "javax.faces.component.UISelectItems",
41      isComponentAlreadyDefined = false,
42      allowedChildComponenents = "NONE")
43  public interface SelectItemsTagDeclaration extends HasId, HasBinding, HasItemLabel {
44  
45    /**
46     * Value binding expression pointing at a List or array of SelectItem instances containing
47     * the information for this option.
48     */
49    @TagAttribute
50    @UIComponentTagAttribute(
51        type = {"javax.faces.model.SelectItem[]", "java.lang.Object[]", "java.util.Collection"},
52        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
53    void setValue(String value);
54  
55    /**
56     * Name of a variable under which the iterated data will be exposed.
57     * It may be referred to in EL of other attributes.
58     */
59    @TagAttribute
60    @UIComponentTagAttribute(expression = DynamicExpression.PROHIBITED)
61    void setVar(final String var);
62  
63    /**
64     * Flag indicating whether the option created
65     * by this component is disabled.
66     */
67    @TagAttribute
68    @UIComponentTagAttribute(type = {"boolean"}, defaultValue = "false")
69    void setItemDisabled(String itemDisabled);
70  
71    /**
72     * Value to be returned to the server if this option is selected by the user.
73     */
74    @TagAttribute
75    @UIComponentTagAttribute()
76    void setItemValue(String itemValue);
77  
78    /**
79     * Image to be displayed to the user for this option.
80     */
81    @TagAttribute
82    @UIComponentTagAttribute()
83    void setItemImage(String itemImage);
84  
85    /**
86     * Text value to display as tooltip.
87     */
88    @TagAttribute
89    @UIComponentTagAttribute()
90    void setTip(String tip);
91  
92  }