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.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasVar;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRoot;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.IsShowRootJunction;
37  
38  import javax.faces.component.UIData;
39  
40  /**
41   * A tree with classical look. 
42   * Usually used with icons and junction lines to open folder, etc.
43   */
44  @Tag(name = "tree")
45  @BodyContentDescription(anyTagOf = "<tc:treeData>")
46  @UIComponentTag(
47      uiComponent = "org.apache.myfaces.tobago.component.UITree",
48      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUITree",
49      uiComponentFacesClass = "javax.faces.component.UIData",
50      componentFamily = UIData.COMPONENT_FAMILY,
51      rendererType = RendererTypes.TREE,
52      allowedChildComponenents = {
53          "org.apache.myfaces.tobago.TreeNode",
54          "org.apache.myfaces.tobago.TreeData"
55          })
56  public interface TreeTagDeclaration
57      extends HasIdBindingAndRendered, HasValue, HasVar, IsGridLayoutComponent, HasMarkup, HasCurrentMarkup,
58      IsShowRoot, IsShowRootJunction {
59  
60    /**
61     * Flag indicating whether or not this component should be render selectable items.
62     * Possible values are:
63     * <ul>
64     * <li><strong>none</strong> : not selectable</li>
65     * <li><strong>multi</strong> : a multi section tree is rendered</li>
66     * <li><strong>single</strong> : a single section tree is rendered</li>
67     * <li><strong>multiLeafOnly</strong> : a multi section tree is rendered,
68     * only leaf's are selectable</li>
69     * <li><strong>singleLeafOnly</strong> : a single section tree is rendered,
70     * only leaf's are selectable</li>
71     * </ul>
72     */
73    @TagAttribute
74    @UIComponentTagAttribute(
75        defaultValue = "multi",
76        allowedValues = {"none", "multi", "single", "multiLeafOnly", "singleLeafOnly"})
77    void setSelectable(String selectable);
78  
79    /**
80     * <strong>ValueBindingExpression</strong> pointing to a object to save the
81     * component's state.
82     */
83    @TagAttribute
84    @UIComponentTagAttribute(
85        type = "org.apache.myfaces.tobago.model.TreeState",
86        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED,
87        generate = false)
88    void setState(String state);
89  }