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.custom.dojolayouts;
21
22 import javax.faces.component.UIOutput;
23
24 import org.apache.myfaces.component.StyleAware;
25 import org.apache.myfaces.custom.dojo.DojoWidget;
26
27 /*
28 * //faces config definition, please cut/paste it into your faces-config
29 * <component> <component-type>org.apache.myfaces.TitlePane</component-type>
30 * <component-class>org.apache.myfaces.custom.dojolayout.TitlePane</component-class>
31 * </component> <renderer> <component-family>javax.faces.Output</component-family>
32 * <renderer-type>javax.faces.Panel</renderer-type>
33 * <renderer-class>org.apache.myfaces.custom.dojolayout.TitlePaneRenderer</renderer-class>
34 * </renderer>
35 *
36 */
37
38 /**
39 * Title Pane layouting element.
40 *
41 * TitlePane Component class
42 *
43 * @JSFComponent
44 * name = "s:layoutingTitlePane"
45 * class = "org.apache.myfaces.custom.dojolayouts.TitlePane"
46 * tagClass = "org.apache.myfaces.custom.dojolayouts.TitlePaneTag"
47 *
48 */
49 public abstract class AbstractTitlePane extends UIOutput
50 implements DojoWidget, StyleAware
51 {
52
53 public static final String COMPONENT_FAMILY = "javax.faces.Output";
54
55 public static final String COMPONENT_TYPE = "org.apache.myfaces.TitlePane";
56
57 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.TitlePaneRenderer";
58
59 /**
60 * Optional enforced dojo widgetId
61 *
62 * @JSFProperty
63 */
64 public abstract String getWidgetId();
65
66 /**
67 * optional widget var name, if this is not used only an autogenerated value is set
68 *
69 * @JSFProperty
70 */
71 public abstract String getWidgetVar();
72
73 /**
74 * the css node class for the container part of the element
75 *
76 * @JSFProperty
77 */
78 public abstract String getContainerNodeClass();
79
80 /**
81 * Label for the titled paned element
82 *
83 * @JSFProperty
84 */
85 public abstract String getLabel();
86
87 /**
88 * the css node class for the label part of the pane
89 *
90 * @JSFProperty
91 */
92 public abstract String getLabelNodeClass();
93
94 /**
95 * The CSS class for this element. Corresponds to the HTML 'class' attribute.
96 *
97 * @JSFProperty
98 */
99 public abstract String getStyle();
100
101 /**
102 * The CSS class for this element. Corresponds to the HTML 'class' attribute.
103 *
104 * @JSFProperty
105 */
106 public abstract String getStyleClass();
107
108 }