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      allowedChildComponenents = {
51          "org.apache.myfaces.tobago.TreeNode",
52          "org.apache.myfaces.tobago.TreeData"
53      })
54  public interface TreeListboxTagDeclaration
55      extends HasIdBindingAndRendered, HasValue, HasVar, IsVisual, IsRequired, HasSize {
56  
57    /**
58     * Flag indicating whether or not this component should be render selectable items.
59     * Possible values are:
60     * <ul>
61     * <li><strong>single</strong> : a single section tree is rendered</li>
62     * <li><strong>multiLeafOnly</strong> : a multi section tree is rendered,
63     * only Leaf's are selectable</li>
64     * <li><strong>singleLeafOnly</strong> : a single section tree is rendered,
65     * only Leaf's are selectable</li>
66     * </ul>
67     */
68    @TagAttribute
69    @UIComponentTagAttribute(
70        type = "org.apache.myfaces.tobago.model.Selectable",
71        defaultValue = Selectable.STRING_SINGLE,
72        allowedValues = {Selectable.STRING_SINGLE, Selectable.STRING_MULTI_LEAF_ONLY, Selectable.STRING_SINGLE_LEAF_ONLY},
73        defaultCode = "org.apache.myfaces.tobago.model.Selectable.single")
74    void setSelectable(String selectable);
75  
76    /**
77     * <strong>ValueBindingExpression</strong> pointing to a object to save the
78     * component's state.
79     */
80    @TagAttribute
81    @UIComponentTagAttribute(
82        type = "org.apache.myfaces.tobago.model.TreeState",
83        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED,
84        generate = false)
85    void setState(String state);
86  }