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