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.Behavior;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
27  import org.apache.myfaces.tobago.component.ClientBehaviors;
28  import org.apache.myfaces.tobago.component.RendererTypes;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverter;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverterMessage;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasRequiredMessageForSelect;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidatorMessage;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
37  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValueChangeListener;
38  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
39  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRequiredForSelect;
40  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
41  
42  import javax.faces.component.UISelectBoolean;
43  
44  /**
45   * Makes a tree node selectable.
46   */
47  @Tag(name = "treeSelect")
48  @UIComponentTag(
49      uiComponent = "org.apache.myfaces.tobago.component.UITreeSelect",
50      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUITreeSelect",
51      uiComponentFacesClass = "javax.faces.component.UISelectBoolean",
52      componentFamily = UISelectBoolean.COMPONENT_FAMILY,
53      rendererType = RendererTypes.TREE_SELECT,
54      allowedChildComponenents = "NONE",
55      behaviors = {
56          @Behavior(
57              name = ClientBehaviors.CHANGE,
58              isDefault = true),
59          @Behavior(
60              name = ClientBehaviors.CLICK),
61          @Behavior(
62              name = ClientBehaviors.DBLCLICK),
63          @Behavior(
64              name = ClientBehaviors.FOCUS),
65          @Behavior(
66              name = ClientBehaviors.BLUR)
67      })
68  public interface TreeSelectTagDeclaration
69      extends HasIdBindingAndRendered, HasLabel, HasTip, IsVisual, HasValue, HasValueChangeListener,
70      IsDisabled, IsRequiredForSelect, HasConverter,
71      HasValidatorMessage, HasRequiredMessageForSelect, HasConverterMessage {
72  
73    /**
74     * Show a checkbox to visualize the selection state.
75     * This is useful to hide the checkbox, e. g. dependent of the type of the node.
76     */
77    @TagAttribute
78    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
79    void setShowCheckbox(String showCheckbox);
80  }