-
Notifications
You must be signed in to change notification settings - Fork 125
/
appframe.opa
296 lines (254 loc) · 9.45 KB
/
appframe.opa
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
/*
Copyright © 2011 MLstate
This file is part of OPA.
OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* An application skeleton with common configurable features.
*
* @category WIDGET
* @author Guillem Rieu, Hugo Heuzard 2011
* @destination PUBLIC
* @stability EXPERIMENTAL
*/
import stdlib.widgets.{core,button,sidepanel,loginbox,notification}
type WAppFrame.sidepanel_conf = {
style: WStyler.styler
size: int
}
type WAppFrame.config = {
topbar : option(WAppFrame.sidepanel_conf) /** none means no topbar */
sidebar : option(WAppFrame.sidepanel_conf) /** none means no sidebar */
statusbar : option(WAppFrame.sidepanel_conf) /** none means no statusbar */
notification : WNotification.config /** notification widget configuration */
loginbox: option(WStyler.styler) /** none means no loginbox */
searchbox: option(WStyler.styler) /** none means no searcgbox */
}
type WAppFrame.content = {
topbar : xhtml /** Top elements */
main : xhtml /** Main content */
statusbar : xhtml /** Status bar content */
loginbox : xhtml
}
type WAppFrame.action = {
on_search : (option(string) -> void)
}
WAppFrame =
searchbar_config(some : WAppFrame.sidepanel_conf): WSidepanel.config =
{WSidepanel.default_config_noresize with
get_handle = WSidepanel.no_handles
get_size = _ -> {size={px=some.size}}
place = {right}
position = {fixed}
get_zindex = _ -> 25
}
{{
/**
* {1 High-level interface}
*/
/**
* A default configuration for [WAppFrame]. It should be used as base to
* customize the component.
*/
default_config : WAppFrame.config = {
topbar = {some={size = 40 style=WStyler.make_style(css {background: #336699;})}}
sidebar= {some={size = 200 style=WStyler.make_style(css {background: #225588;border-left: 1px solid #114477})}}
statusbar = {some={size = 30 style=WStyler.make_style(css {background: #336699})}}
notification = WNotification.default_config
loginbox= {some=WStyler.make_style(css {display:inline-block;})}
searchbox= {some=WStyler.make_style(css {display:inline-block;})}
}
/** A configuration with all optional features disabled */
minimal_config : WAppFrame.config = {
topbar = none
sidebar = none
statusbar = none
notification = WNotification.default_config
loginbox = none
searchbox = none
}
// full_config /* A configuration with all optional features enabled */
// mlstate_config /* A base configuration for MLstate applications */
/**
* Main [WAppFrame] building function
*/
html(config : WAppFrame.config, id : string, action : WAppFrame.action, content : WAppFrame.content) : xhtml =
/* Search box */
/* Callback on a search event */
on_change_search() : void =
search_value = Dom.get_value(#{get_searchfield_id(id)})
if search_value == "" then
action.on_search(none)
else
action.on_search(some(search_value))
searchbox_xhtml =
match config.searchbox with
| {~some} ->
<div>
<input type="text" id="{get_searchfield_id(id)}" />
<a onclick={_ -> on_change_search()}>Search</a>
</div> |> WStyler.set(some,_)
| {none} -> <></>
sidebar_xhtml =
match config.sidebar with
| {~some} ->
/**
* A [WSidePanel] configuration for the search bar
*/
searchbar_config: WSidepanel.config = searchbar_config(some)
econtent =
<div style="height:100%;width:{some.size}px">
<a onclick={_ -> WSidepanel.do_close(searchbar_config, get_left_sidepanel_id(id), true)} > close </a>
<div id="{get_searchres_content_id(id)}">
</div>
</div>
|> WStyler.add(some.style,_)
WSidepanel.html(searchbar_config, get_left_sidepanel_id(id),econtent,false)
| {none} -> <></>
loginbox_xhtml =
match config.loginbox with
| {~some} -> <div>{content.loginbox}</div> |> WStyler.add(some,_)
| {none} -> <></>
/* Top bar content */
(topbar_xhtml,topbar_size) =
match config.topbar with
| {~some} ->
/**
* A [WSidePanel] configuration for the top bar
*/
topbar_config: WSidepanel.config =
{WSidepanel.default_config_noresize with
get_handle = WSidepanel.no_handles
get_size = _ -> {size={px=some.size }}
place = {top}
position = {fixed}
}
econtent =
<div style="width:100%;height:100%">
<div style="float:right;height:100%">
{searchbox_xhtml}
</div>
<div style="float:right;height:100%">
{loginbox_xhtml}
</div>
<div id="{get_header_id(id)}">
{content.topbar}
</div>
</div>
|> WStyler.add(some.style,_)
(WSidepanel.html(topbar_config, get_top_sidepanel_id(id), econtent, true),
some.size)
| {none} -> (<></>,0)
/* Status bar content */
(statusbar_xhtml,statusbar_size) =
match config.statusbar with
| {~some} ->
/**
* A [WSidePanel] configuration for the status bar
*/
statusbar_config: WSidepanel.config =
{WSidepanel.default_config_noresize with
get_handle = WSidepanel.no_handles
get_size = _ -> {size={px=some.size}}
//get_size = _ -> {normal}
place = {bottom}
position = {fixed}
}
econtent = <div id="{get_bottom_sidepanel_id(id)}" style="width:100%;height:100%">
{content.statusbar}
</div>
|> WStyler.add(some.style,_)
(WSidepanel.html(statusbar_config, "{id}_statusbar",econtent,true),
some.size)
| {none} -> (<></>,0)
/** [WAppFrame] xhtml building */
notif = WNotification.html(WNotification.default_config,get_notification_id(id))
appframe_xhtml =
<div id="{get_main_id(id)}">
{topbar_xhtml}
<div style={css {margin: {topbar_size}px 0px {statusbar_size}px 0px;padding:0px}}>
{sidebar_xhtml}
<div id="{get_content_id(id)}">
{content.main}
</div>
</div>
{statusbar_xhtml}
{notif}
</div>
appframe_xhtml
/**
* Set the sidebar content
*/
do_set_sidebar_content(id : string, config : WAppFrame.config, xhtml : xhtml) : void =
match config.sidebar with
| ~{some} ->
searchbar_config: WSidepanel.config = searchbar_config(some)
do Dom.transform([#{get_searchres_content_id(id)} +<- xhtml])
do WSidepanel.do_open(searchbar_config, get_searchbar_id(id), true)
void
| _ -> void
/**
* Open the sidebar
*/
do_open_sidebar(id : string, config) : void =
match config.sidebar with
| ~{some} ->
searchbar_config: WSidepanel.config = searchbar_config(some)
do WSidepanel.do_open(searchbar_config, get_left_sidepanel_id(id), true)
void
| _ -> void
/**
* Close the sidebar
*/
do_close_sidebar(id : string, config) : void =
match config.sidebar with
| ~{some} ->
searchbar_config: WSidepanel.config = searchbar_config(some)
do WSidepanel.do_close(searchbar_config, get_left_sidepanel_id(id), true)
void
| _ -> void
/**
* Set the content of the topbar
*/
do_set_topbar(id : string, xhtml : xhtml ) : void =
Dom.transform([#{get_header_id(id)} <- xhtml])
/**
* Set the content of the status bar
*/
do_set_status(id : string, xhtml : xhtml ) : void =
Dom.transform([#{get_bottom_sidepanel_id(id)} <- xhtml])
/**
* Set the main content
*/
do_set_content(id : string, xhtml : xhtml) : void =
Dom.transform([#{get_content_id(id)} <- xhtml])
/**
* Display a notification box
*/
do_notify(id : string, config : WAppFrame.config, notification : WNotification.box) =
WNotification.notify(config.notification, WNotification.box_id(get_notification_id(id)), notification)
/**
* {1 Private functions aimed at internal use}
*
* Do not use them outside of the module.
*/
@private get_notification_id(id) = id ^ "_notification"
@private get_main_id(id) = id ^ "_main"
@private get_content_id(id) = id ^ "_content"
@private get_searchbar_id(id) = id ^ "_searchbar"
@private get_searchres_id(id) = id ^ "_searchres"
@private get_header_id(id) = id ^ "_header"
@private get_searchres_content_id(id) = id ^ "_searchrescontent"
@private get_searchfield_id(id) = id ^ "_search_field"
@private get_top_sidepanel_id(id) = id ^ "_side_topbar"
@private get_bottom_sidepanel_id(id)= id ^ "_side_statusbar"
@private get_left_sidepanel_id(id) = id ^ "_side_left"
}}