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.BodyContentDescription;
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.component.RendererTypes;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasSize;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasVar;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRequired;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
35  import org.apache.myfaces.tobago.model.Selectable;
36  
37  import javax.faces.component.UIData;
38  
39  /**
40   * A tree data structure displayed as a set of list boxes.
41   */
42  @Tag(name = "treeListbox")
43  @BodyContentDescription(anyTagOf = "<tc:treeNode>|<tc:treeData>")
44  @UIComponentTag(
45      uiComponent = "org.apache.myfaces.tobago.component.UITreeListbox",
46      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUITreeListbox",
47      uiComponentFacesClass = "javax.faces.component.UIData",
48      componentFamily = UIData.COMPONENT_FAMILY,
49      rendererType = RendererTypes.TREE_LISTBOX,
50      interfaces = {
51          // As long as no behavior event names are defined, ClientBehaviorHolder must be implemented for Majorra.
52          "javax.faces.component.behavior.ClientBehaviorHolder"
53      },
54      allowedChildComponenents = {
55          "org.apache.myfaces.tobago.TreeNode",
56          "org.apache.myfaces.tobago.TreeData"
57      })
58  public interface TreeListboxTagDeclaration
59      extends HasIdBindingAndRendered, HasValue, HasVar, IsVisual, IsRequired, HasSize {
60  
61    /**
62     * Flag indicating whether or not this component should be render selectable items.
63     * Possible values are:
64     * <ul>
65     * <li><strong>single</strong> : a single section tree is rendered</li>
66     * <li><strong>multiLeafOnly</strong> : a multi section tree is rendered,
67     * only Leaf's are selectable</li>
68     * <li><strong>singleLeafOnly</strong> : a single section tree is rendered,
69     * only Leaf's are selectable</li>
70     * </ul>
71     */
72    @TagAttribute
73    @UIComponentTagAttribute(
74        type = "org.apache.myfaces.tobago.model.Selectable",
75        defaultValue = Selectable.SINGLE,
76        allowedValues = {Selectable.SINGLE, Selectable.MULTI_LEAF_ONLY, Selectable.SINGLE_LEAF_ONLY},
77        defaultCode = "org.apache.myfaces.tobago.model.Selectable.single")
78    void setSelectable(String selectable);
79  
80    /**
81     * <strong>ValueBindingExpression</strong> pointing to a object to save the
82     * component's state.
83     */
84    @TagAttribute
85    @UIComponentTagAttribute(
86        type = "org.apache.myfaces.tobago.model.TreeState",
87        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED,
88        generate = false)
89    void setState(String state);
90  }