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  
37  import javax.faces.component.UIData;
38  
39  /**
40   * A tree which will be displayed like a flat menu.
41   * This menu is often used for navigation on the left side of an application.
42   */
43  @Tag(name = "treeMenu")
44  @BodyContentDescription(anyTagOf = "<tc:treeData>")
45  @UIComponentTag(
46      uiComponent = "org.apache.myfaces.tobago.component.UITreeMenu",
47      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUITree",
48      uiComponentFacesClass = "javax.faces.component.UIData",
49      componentFamily = UIData.COMPONENT_FAMILY,
50      rendererType = RendererTypes.TREE_MENU,
51      allowedChildComponenents = {
52          "org.apache.myfaces.tobago.TreeNode",
53          "org.apache.myfaces.tobago.TreeData"
54          })
55  public interface TreeMenuTagDeclaration
56      extends HasIdBindingAndRendered, HasValue, HasVar, IsGridLayoutComponent, HasMarkup, HasCurrentMarkup,
57      IsShowRoot {
58  
59    /**
60     *
61     * <strong>ValueBindingExpression</strong> pointing to a object to save the
62     * component's state.
63     */
64    @TagAttribute
65    @UIComponentTagAttribute(
66        type = "org.apache.myfaces.tobago.model.TreeState",
67        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED,
68        generate = false)
69    void setState(String state);
70  
71  }