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.HasValue;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasVar;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRoot;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRootJunction;
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 with classical look. 
41   * Usually used with icons and junction lines to open folder, etc.
42   */
43  @Tag(name = "tree")
44  @BodyContentDescription(anyTagOf = "<tc:treeData>")
45  @UIComponentTag(
46      uiComponent = "org.apache.myfaces.tobago.component.UITree",
47      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUITree",
48      uiComponentFacesClass = "javax.faces.component.UIData",
49      componentFamily = UIData.COMPONENT_FAMILY,
50      rendererType = RendererTypes.TREE,
51      allowedChildComponenents = {
52          "org.apache.myfaces.tobago.TreeNode",
53          "org.apache.myfaces.tobago.TreeData"
54          })
55  public interface TreeTagDeclaration
56      extends HasIdBindingAndRendered, HasValue, HasVar, IsVisual,
57      IsShowRoot, IsShowRootJunction {
58  
59    /**
60     * Flag indicating whether or not this component should be render selectable items.
61     * Possible values are:
62     * <ul>
63     * <li><strong>none</strong> : not selectable</li>
64     * <li><strong>multi</strong> : a multi section tree is rendered</li>
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.STRING_MULTI,
76        allowedValues = {
77            Selectable.STRING_NONE,
78            Selectable.STRING_MULTI,
79            Selectable.STRING_SINGLE,
80            Selectable.STRING_MULTI_LEAF_ONLY,
81            Selectable.STRING_SINGLE_LEAF_ONLY},
82        defaultCode = "org.apache.myfaces.tobago.model.Selectable.multi")
83    void setSelectable(String selectable);
84  
85    /**
86     * <strong>ValueBindingExpression</strong> pointing to a object to save the
87     * component's state.
88     */
89    @TagAttribute
90    @UIComponentTagAttribute(
91        type = "org.apache.myfaces.tobago.model.TreeState",
92        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED,
93        generate = false)
94    void setState(String state);
95  }