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 package org.apache.myfaces.custom.tree;
20
21 import javax.faces.component.UISelectItem;
22
23 /**
24 * Renders a HTML input of type "treeCheckbox".
25 *
26 * The associated comes from the treeCheckbox itemLabel and itemValue.
27 * The selected items come from an extended selectManyCheckbox
28 * component with layout "spread". The selectManyCheckbox is
29 * referenced by the "for" attribute.
30 *
31 * All HTML pass-through attributes for this input are taken from
32 * the associated selectManyCheckbox.
33 *
34 * Unless otherwise specified, all attributes accept static values or EL expressions.
35 *
36 * @JSFComponent
37 * name = "t:treeCheckbox"
38 * class = "org.apache.myfaces.custom.tree.HtmlTreeCheckbox"
39 * tagClass = "org.apache.myfaces.custom.tree.taglib.TreeCheckboxTag"
40 * @since 1.1.7
41 * @author <a href="mailto:dlestrat@yahoo.com">David Le Strat</a>
42 */
43 public abstract class AbstractHtmlTreeCheckbox extends UISelectItem
44 {
45
46 /** The for attribute declaration. */
47 public static final String FOR_ATTR = "for".intern();
48
49 /** The component type. */
50 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlTreeCheckbox";
51
52 /** The component family. */
53 public static final String COMPONENT_FAMILY = "org.apache.myfaces.HtmlTreeCheckbox";
54
55 /** The default renderer type. */
56 private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.HtmlTreeCheckbox";
57
58 /**
59 * id of the referenced extended selectManyCheckbox component
60 *
61 * @JSFProperty
62 * @return The for attribute.
63 */
64 public abstract String getFor();
65
66 }