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 * PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
29 *
30 * @JSFComponent
31 * name = "s:floatingPane"
32 * class = "org.apache.myfaces.custom.dojolayouts.FloatingPaneBase"
33 * tagClass = "org.apache.myfaces.custom.dojolayouts.FloatingPaneTag"
34 *
35 *
36 */
37 public abstract class AbstractFloatingPaneBase extends UIOutput
38 implements DojoWidget, StyleAware {
39
40 public static final String COMPONENT_FAMILY = "javax.faces.Output";
41
42 public static final String COMPONENT_TYPE = "org.apache.myfaces.FloatingPaneBase";
43
44 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.FloatingPaneBaseRenderer";
45
46 /**
47 * limit to parent container
48 *
49 * @JSFProperty
50 */
51 public abstract Boolean getConstrainToContainer();
52
53 /**
54 * if true a close button is displayed
55 *
56 * @JSFProperty
57 */
58 public abstract Boolean getDisplayCloseAction();
59
60 /**
61 * if true a minimize button is displayed
62 *
63 * @JSFProperty
64 */
65 public abstract Boolean getDisplayMinimizeAction();
66
67 /**
68 * Shadow drawn or not
69 *
70 * @JSFProperty
71 */
72 public abstract Boolean getHasShadow();
73
74 /**
75 * The pane icon source
76 *
77 * @JSFProperty
78 */
79 public abstract String getIconSrc();
80
81 /**
82 * Description for the attribute
83 *
84 * @JSFProperty
85 */
86 public abstract Boolean getModal();
87
88 /**
89 * Window resizable
90 *
91 * @JSFProperty
92 */
93 public abstract Boolean getResizable();
94
95 /**
96 * The taskbar id
97 *
98 * @JSFProperty
99 */
100 public abstract String getTaskBarId();
101
102 /**
103 * the floating pane Title
104 *
105 * @JSFProperty
106 */
107 public abstract String getTitle();
108
109 /**
110 * Displays the title bar of the Window
111 *
112 * @JSFProperty
113 */
114 public abstract Boolean getTitleBarDisplay();
115
116 /**
117 * Optional enforced dojo widgetId
118 *
119 * @JSFProperty
120 */
121 public abstract String getWidgetId();
122
123 /**
124 * optional widget var name, if this is not used only an autogenerated value is set
125 *
126 * @JSFProperty
127 */
128 public abstract String getWidgetVar();
129
130 /**
131 * Display state of the window
132 *
133 * @JSFProperty
134 */
135 public abstract String getWindowState();
136
137 /**
138 * The CSS class for this element. Corresponds to the HTML 'class' attribute.
139 *
140 * @JSFProperty
141 */
142 public abstract String getStyle();
143
144 /**
145 * The CSS class for this element. Corresponds to the HTML 'class' attribute.
146 *
147 * @JSFProperty
148 */
149 public abstract String getStyleClass();
150
151 }