combobox.xml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493
  1. <krpano>
  2. <!--
  3. combobox.xml Plugin - krpano 1.19-pr13
  4. - This plugin converts <combobox> elements in the current xml
  5. into <layer> container, scrollarea and textfield elements.
  6. - Additionally it's also possible to add and remove combobox
  7. elements also dynamically.
  8. - The full xml implementation allows many ways of customizing
  9. for own needs - custom designs/styles, custom functionality.
  10. - The plugin works automatically the same for HTML5 and Flash.
  11. - It's possible to use this plugin as replacement for the old
  12. combobox.swf/combobox.js plugins, the action interfaces are
  13. the same.
  14. Syntax for Static XML Code:
  15. <combobox name="..." design="..." ...any layer settings...>
  16. <item name="..." caption="..." onclick="..." />
  17. <item name="..." caption="..." onclick="..." />
  18. </combobox>
  19. Syntax for Dynamic XML Code:
  20. - Global Actions:
  21. addComboboxLayer(cbname, design*)
  22. removeComboboxLayer(cbname);
  23. - Combobox Layer Actions:
  24. layer[cbname].addItem(caption, onclick)
  25. layer[cbname].addNamedItem(name, caption, onclick)
  26. layer[cbname].addIdItem(name, caption, onclick); same as addNamedItem (for combobox.js compatibility)
  27. layer[cbname].selectItem(caption)
  28. layer[cbname].selectItemByName(name_or_index)
  29. layer[cbname].selectIdItem(name_or_index) same as selectItemByName (for combobox.js compatibility)
  30. layer[cbname].removeAll()
  31. layer[cbname].openList()
  32. layer[cbname].closeList()
  33. - Events/Callbacks:
  34. layer[cbname].onChange
  35. - Combobox Layer Attributes:
  36. layer[cbname].item - krpano Array of the items
  37. layer[cbname].selecteditemindex - current selected item index
  38. -->
  39. <!-- path to the scrollarea plugin -->
  40. <combobox_scrollareaplugin
  41. url.html5="%SWFPATH%/plugins/scrollarea.js"
  42. url.flash="%SWFPATH%/plugins/scrollarea.swf"
  43. />
  44. <!-- core internal layer styles -->
  45. <style name="combobox_container_style" type="container" maskchildren="true" bgcapture="true" visible="false" onclick="combobox_onclick_event();" mergedalpha="false" alpha="1.0" />
  46. <style name="combobox_marker_style" type="text" align="righttop" edge="center" html="▼" havemarkersize="false" onautosized="set(havemarkersize,true);" mergedalpha="false" alpha="1.0" />
  47. <style name="combobox_item_style" type="text" wordwrap="false" vcenter="true" align="lefttop" onover="if(!combbox_item_pressed,onoveritem());asyncloop(hovering,,if(!combbox_item_pressed,onoutitem()));" ondown="onoveritem(); set(combbox_item_pressed,true);" onup="onoutitem(); set(combbox_item_pressed,false);" onoveritem="set(bg,true);" onoutitem="set(bg,false);" mergedalpha="false" alpha="1.0" />
  48. <!-- several pre-defined designs -->
  49. <combobox_design name="default" margin="2" open_close_speed="0.25">
  50. <!-- default design - white box with black text and blue selection -->
  51. <style name="combobox_container_style" bgalpha="1.0" bgcolor="0xFFFFFF" bgborder="1 0xFFFFFF 0.5" bgroundedge="1" bgshadow="0 1 3 0x000000 1.0" />
  52. <style name="combobox_marker_style" css="color:#FFFFFF;" bg="false" txtshadow="0 0 2 0x000000 1" />
  53. <style name="combobox_item_style" css="color:#222222;" padding="4 4" bg="false" bgcolor="0xC7E4FC" bgalpha="1.0" bgroundedge="1" txtshadow="0 0 1 0xFFFFFF 1.0" />
  54. </combobox_design>
  55. <combobox_design name="vtour" margin="4" open_close_speed="0.25">
  56. <!-- default vtourskin.xml design -->
  57. <style name="combobox_container_style" bgalpha="0.8" bgcolor="0x2D3E50" bgborder="0" bgroundedge="1" bgshadow="0 4 10 0x000000 0.3" />
  58. <style name="combobox_marker_style" css="color:#FFFFFF;" bg="false" txtshadow="0 0 2 0x000000 1" />
  59. <style name="combobox_item_style" css="color:#FFFFFF;" padding="4 4" bg="false" bgcolor="0xFFFFFF" bgalpha="0.5" bgroundedge="0" txtshadow="0 0 2 0x000000 1" />
  60. </combobox_design>
  61. <!-- internal events -->
  62. <events name="combobox_xml_plugin_events" keep="true"
  63. onxmlcomplete="combobox_parse_xml_elements();"
  64. onresize="combobox_closelist();"
  65. />
  66. <!-- krpano version check -->
  67. <action name="combobox_versioncheck" autorun="preinit">
  68. if(build LT '2017-09-13',
  69. error('combobox.xml - too old krpano version!');
  70. set(events[combobox_xml_plugin_events].name, null);
  71. set(action[addComboboxLayer].content, '');
  72. set(action[removeComboboxLayer].content, '');
  73. );
  74. </action>
  75. <!-- convert all <combobox> elements to layers -->
  76. <action name="combobox_parse_xml_elements" scope="local">
  77. if(global.combobox,
  78. def(i, integer, 0);
  79. def(cnt, integer, get(global.combobox.count));
  80. copy(combobox_src, global.combobox);
  81. delete(global.combobox);
  82. if(cnt GT 0, loop(i LT cnt,
  83. copy(cb, combobox_src[get(i)]);
  84. if(cb AND cb.name AND cb.parsed != true,
  85. set(cb.parsed, true);
  86. addComboboxLayer(get(cb.name), get(cb.design));
  87. copy(ly, layer[get(cb.name)]);
  88. copyattributes(get(ly), get(cb));
  89. set(ly.keep, true);
  90. def(item_cnt, integer, get(cb.item.count));
  91. if(item_cnt GT 0,
  92. def(item_i, integer, 0);
  93. loop(item_i LT item_cnt,
  94. combobox_additem(get(ly.name), get(cb.item[get(item_i)].name), get(cb.item[get(item_i)].caption), get(cb.item[get(item_i)].onclick));
  95. inc(item_i);
  96. );
  97. );
  98. );
  99. inc(i);
  100. ));
  101. );
  102. </action>
  103. <!-- dynamically add a combobox layer -->
  104. <action name="addComboboxLayer" scope="local" args="cbname, design">
  105. <!-- create the layer -->
  106. addlayer(get(cbname));
  107. copy(cb, layer[get(cbname)]);
  108. set(cb.keep, true);
  109. <!-- copy the design settings (or set defaults) -->
  110. if(!combobox_design[get(design)].name, set(design,'default'));
  111. copy(cb.cbdesign, combobox_design[get(design)]);
  112. calc(cb.margin, cb.cbdesign.margin !== null ? cb.cbdesign.margin : 2);
  113. calc(cb.open_close_speed, cb.cbdesign.open_close_speed !== null ? cb.cbdesign.open_close_speed : 0.25);
  114. <!-- load the styles and copy the design style settings -->
  115. cb.loadstyle(combobox_container_style);
  116. copyattributes(get(cb), get(cb.cbdesign.style[combobox_container_style]));
  117. <!-- add/build/map actions -->
  118. calc(cb.addItem, 'combobox_additem(' + cbname + ', null, "%%1", "%%2");');
  119. calc(cb.addNamedItem, 'combobox_additem(' + cbname + ', "%%1", "%%2", "%%3");');
  120. calc(cb.addIdItem, 'combobox_additem(' + cbname + ', "%%1", "%%2", "%%3");');
  121. calc(cb.selectItem, 'combobox_finditem(' + cbname + ', "%%1", __cb_fi); if(__cb_fi GE 0, combobox_selectitem(' + cbname + ', get(__cb_fi))); delete(__cb_fi);');
  122. calc(cb.selectItemByName, 'combobox_selectitem(' + cbname + ', "%%1");');
  123. calc(cb.selectIdItem, 'combobox_selectitem(' + cbname + ', "%%1");');
  124. calc(cb.removeAll, 'combobox_removeitems(' + cbname + ');');
  125. calc(cb.openList, 'combobox_openlist(' + cbname + ');');
  126. calc(cb.closeList, 'combobox_closelist(' + cbname + ');');
  127. <!-- create sub-layers -->
  128. def(saname, string, 'combobox_%1_scrollarea');
  129. addlayer(get(saname));
  130. copy(sa, layer[get(saname)]);
  131. copy(sa.parent, cbname);
  132. copy(sa.url, combobox_scrollareaplugin.url);
  133. copy(sa.keep, true);
  134. copy(sa.align, lefttop);
  135. set(sa.direction, v);
  136. set(sa.enabled, false);
  137. set(sa.width, 100%);
  138. set(sa.height, 100%);
  139. copy(cb.scrollarea, sa);
  140. def(mkname, string, 'combobox_%1_marker');
  141. addlayer(get(mkname));
  142. copy(mk, layer[get(mkname)]);
  143. copy(mk.parent, saname);
  144. copy(mk.keep, true);
  145. mk.loadstyle(combobox_marker_style);
  146. copyattributes(get(mk), get(cb.cbdesign.style[combobox_marker_style]));
  147. copy(cb.marker, mk);
  148. <!-- item data array -->
  149. cb.createarray('item');
  150. <!-- item autosizing information -->
  151. set(cb.autosize_i, 0);
  152. set(cb.autosize_cnt, 0);
  153. set(cb.autosize_max_w, 0);
  154. set(cb.autosize_max_h, 0);
  155. set(cb.lastselecteditemindex, 0);
  156. set(cb.selecteditemindex, 0);
  157. </action>
  158. <!-- dynamically remove a combobox element -->
  159. <action name="removeComboboxLayer" scope="local" args="cbname">
  160. if(layer[get(cbname)],
  161. copy(cb, layer[get(cbname)]);
  162. if(cb === global.openedcombobox, delete(global.openedcombobox));
  163. if(cb,
  164. removelayer(get(cbname), true);
  165. );
  166. );
  167. </action>
  168. <!-- default onclick event for combobox elements: open the list -->
  169. <action name="combobox_onclick_event">
  170. combobox_openlist(get(name));
  171. </action>
  172. <!-- dynamically add items -->
  173. <action name="combobox_additem" scope="local" args="cbname, itemname, itemcaption, itemonclick">
  174. copy(cb, layer[get(cbname)]);
  175. <!-- when no item name is set, generate an automatic one -->
  176. if(itemname === null, calc(itemname, 'autoname_' + cb.item.count); );
  177. <!-- save the item caption and onclick event -->
  178. copy(cb.item[get(itemname)].caption, itemcaption);
  179. copy(cb.item[get(itemname)].onclick, itemonclick);
  180. inc(cb.autosize_cnt);
  181. <!-- create the item layer/textfield -->
  182. calc(itemlayername, 'comboboxitem_' + cbname + '_' + itemname);
  183. addlayer(get(itemlayername));
  184. copy(li, layer[get(itemlayername)]);
  185. li.loadstyle(combobox_item_style);
  186. copyattributes(get(li), get(cb.cbdesign.style[combobox_item_style]));
  187. copy(li.parent, cb.scrollarea.name);
  188. copy(li.keep, true);
  189. copy(li.cblayername, cb.name);
  190. copy(li.itemname, itemname);
  191. copy(li.html, itemcaption);
  192. set(li.onautosized, delayedcall(0,combobox_item_autosize_update()) );
  193. set(li.onclick, combobox_item_onclick() );
  194. copy(cb.item[get(itemname)].itemlayername, itemlayername);
  195. </action>
  196. <!-- onautosized callback from the item textfield -->
  197. <action name="combobox_item_autosize_update" scope="local">
  198. copy(cb, layer[get(caller.cblayername)]);
  199. inc(cb.autosize_i);
  200. Math.max(cb.autosize_max_w, caller.width);
  201. Math.max(cb.autosize_max_h, caller.height);
  202. if(cb.autosize_i == cb.autosize_cnt, combobox_align_items(get(cb.name)); );
  203. </action>
  204. <!-- align the image and set the combobox size -->
  205. <action name="combobox_align_items" scope="local" args="cbname">
  206. copy(cb, layer[get(cbname)]);
  207. if(cb.marker.havemarkersize == false OR cb.scrollarea.loaded == false,
  208. <!-- wait until everything is ready -->
  209. delayedcall(calc(cb.name + '_waitformarkersize'), 0.01, combobox_align_items(get(cbname)) );
  210. ,
  211. <!-- set the item positions and the combobox size -->
  212. if(global.openedcombobox === cb, combobox_closelist() );
  213. copy(sa, cb.scrollarea);
  214. calc(itemwidth, cb.margin GT 0 ? -2 * cb.margin : '100%');
  215. copy(mk_w, cb.marker.width);
  216. copy(item_cnt, cb.autosize_cnt);
  217. for(def(item_i, integer, 0), item_i LT item_cnt, inc(item_i),
  218. copy(li, layer[get(cb.item[get(item_i)].itemlayername)]);
  219. set(li.x, get(cb.margin));
  220. copy(li.width, itemwidth);
  221. copy(li.height, cb.autosize_max_h);
  222. calc(li.y, cb.margin + item_i * (cb.autosize_max_h + cb.margin));
  223. );
  224. if(cb.width == null OR cb.width == cb.lastautosizedwidth,
  225. <!-- no combobox width (or an autosized width) set - set the largest item width -->
  226. calc(cb.width, cb.margin + cb.autosize_max_w + 2 + mk_w + cb.margin);
  227. copy(cb.lastautosizedwidth, cb.width);
  228. );
  229. calc(cb.height, 2*cb.margin + cb.autosize_max_h);
  230. calc(sa.height, cb.margin + item_cnt*(cb.margin+cb.autosize_max_h));
  231. calc(sa.y, -(cb.selecteditemindex * (cb.autosize_max_h + cb.margin)));
  232. calc(cb.marker.x, cb.margin + mk_w/2);
  233. tween(layer[get(cb.name)].marker.y, calc(cb.margin + cb.selecteditemindex*(cb.autosize_max_h + cb.margin) + cb.autosize_max_h/2), 0.1);
  234. <!-- when all is done, show the combobox -->
  235. delayedcall(0.1, set(layer[get(cb.name)].visible,true); );
  236. );
  237. </action>
  238. <!-- default onclick event for items: select the current item, close the list and call the item onclick event -->
  239. <action name="combobox_item_onclick" scope="local">
  240. copy(cb, layer[get(caller.cblayername)]);
  241. copy(itemname, caller.itemname);
  242. combobox_selectitem(get(cb.name), get(itemname));
  243. if(global.openedcombobox === cb, combobox_closelist() );
  244. if(cb.item[get(itemname)].onclick,
  245. <!-- call the onclick event after the combobox has closed -->
  246. delayedcall(get(cb.open_close_speed),
  247. copy(cb.curitem, cb.item[get(itemname)]);
  248. callwith(cb,
  249. cb.item[get(itemname)].onclick();
  250. );
  251. );
  252. );
  253. </action>
  254. <!-- select an item -->
  255. <action name="combobox_selectitem" scope="local" args="cbname, itemname">
  256. if(global.combbox_item_pressed != true,
  257. copy(cb, layer[get(cbname)]);
  258. copy(cb.lastselecteditemindex, cb.selecteditemindex);
  259. copy(cb.selecteditemindex, cb.item[get(itemname)].index);
  260. <!-- call onchange event on selection change -->
  261. if(cb.lastselecteditemindex != cb.selecteditemindex AND cb.onchange,
  262. callwith(cb, onchange() );
  263. );
  264. if(global.openedcombobox === cb,
  265. <!-- when opened, just close to the selected item -->
  266. combobox_closelist();
  267. ,
  268. if(layer[get(cbname)].scrollarea.loaded,
  269. layer[get(cbname)].scrollarea.stopscrolling();
  270. calc(offset, cb.selecteditemindex*(cb.autosize_max_h + cb.margin));
  271. tween(layer[get(cbname)].marker.y, calc(cb.margin + offset + cb.autosize_max_h/2), 0);
  272. tween(layer[get(cbname)].scrollarea.y, calc(-offset), 0, default, layer[get(cbname)].scrollarea.update(); );
  273. );
  274. );
  275. );
  276. </action>
  277. <!-- find an item by its caption, the global variable defined in 'returnvariable' will contain the index -->
  278. <action name="combobox_finditem" scope="local" args="cbname, itemcaption, returnvariable">
  279. copy(cb, layer[get(cbname)]);
  280. copy(item_cnt, cb.item.count);
  281. set(calc('global.' + returnvariable), -1);
  282. for(def(item_i, integer, 0), item_i LT item_cnt, inc(item_i),
  283. if(cb.item[get(item_i)].caption == itemcaption,
  284. copy(calc('global.' + returnvariable), item_i);
  285. copy(item_i, item_cnt);
  286. );
  287. );
  288. </action>
  289. <!-- remove all items (to be able to add new ones) -->
  290. <action name="combobox_removeitems" scope="local" args="cbname">
  291. copy(cb, layer[get(cbname)]);
  292. if(global.openedcombobox === cb, combobox_closelist() );
  293. <!-- remove all item layers -->
  294. calc(item_i, cb.item.count - 1);
  295. loop(item_i GE 0,
  296. removelayer(get(cb.item[get(item_i)].itemlayername));
  297. dec(item_i);
  298. );
  299. <!-- reset the item information -->
  300. set(cb.item.count, 0);
  301. set(cb.autosize_i,0);
  302. set(cb.autosize_cnt, 0);
  303. set(cb.autosize_max_w, 0);
  304. set(cb.autosize_max_h, 0);
  305. set(cb.selecteditemindex, 0);
  306. set(cb.lastselecteditemindex, 0);
  307. if(cb.width == cb.lastautosizedwidth, set(cb.width, null));
  308. </action>
  309. <!-- open the combobox list -->
  310. <action name="combobox_openlist" scope="local" args="cbname">
  311. <!-- if another combobox is already open, close that one first -->
  312. if(global.openedcombobox !== null, combobox_closelist() );
  313. copy(cb, layer[get(cbname)]);
  314. copy(global.openedcombobox, cb);
  315. <!-- find the available screen space above or below the combobox -->
  316. calc(cbheight, 2*cb.margin + cb.autosize_max_h);
  317. set(lx1, 0);
  318. set(ly1, 0);
  319. copy(lx2, cb.pixelwidth);
  320. copy(ly2, cbheight);
  321. layertoscreen(get(cbname), lx1,ly1, lx1,ly1);
  322. layertoscreen(get(cbname), lx2,ly2, lx2,ly2);
  323. calc(space_above, ly1 - area.pixely);
  324. calc(space_below, area.pixelheight - (ly2 - area.pixely));
  325. <!-- the required space for full opening: -->
  326. calc(openheight, cb.margin + cb.autosize_cnt*(cb.margin+cb.autosize_max_h) );
  327. <!-- vertical centered alignment? -->
  328. calc(cb_edge, cb.edge ? cb.edge : cb.align);
  329. calc(iscentered, cb_edge == 'left' OR cb_edge == 'center' OR cb_edge == 'right');
  330. if(iscentered,
  331. calc(openheight_max, space_above + space_below);
  332. ,
  333. Math.max(openheight_max, space_above, space_below);
  334. );
  335. <!-- limit the height to the available space (minus some margin) -->
  336. Math.min(openheight, calc(openheight_max + cbheight - 20));
  337. <!-- need vertical offset? (depending on the available space and the align/edge setting) -->
  338. set(yoffset, null);
  339. calc(top_overflow, -ly1 + area.pixely + openheight/2);
  340. calc(bottom_overflow, ly2 - area.pixely + openheight/2 - area.pixelheight);
  341. if(cb.parent,
  342. <!-- no vertical offset inside other layers, do only a height clipping -->
  343. Math.max(max_overflow, top_overflow, bottom_overflow, 0);
  344. sub(openheight, max_overflow);
  345. ,
  346. if(iscentered,
  347. if(openheight GE (area.pixelheight - 20),
  348. set(yoffset,0);
  349. ,
  350. if(top_overflow GT 0, calc(yoffset, cb.y + top_overflow); );
  351. if(bottom_overflow GT 0, calc(yoffset, cb.y - bottom_overflow); );
  352. );
  353. ,
  354. indexoftxt(isbottomalign, get(cb_edge), 'bottom');
  355. if(space_above GT space_below,
  356. if(isbottomalign LT 0, calc(yoffset, cb.y - openheight + cbheight); );
  357. ,
  358. if(isbottomalign GE 0, calc(yoffset, cb.y - openheight + cbheight); );
  359. );
  360. );
  361. );
  362. if(yoffset != null,
  363. copy(cb.ybackup, cb.y);
  364. tween(layer[get(cbname)].y, calc(yoffset), get(cb.open_close_speed));
  365. );
  366. <!-- center the opened list at the selected item -->
  367. calc(centeritem_y, -1 * (cb.margin + cb.selecteditemindex*(cb.margin+cb.autosize_max_h) + cb.autosize_max_h/2 - openheight/2));
  368. clamp(centeritem_y, calc(openheight - cb.scrollarea.height), 0);
  369. <!-- apply the changes now -->
  370. tween(layer[get(cbname)].height, get(openheight), get(cb.open_close_speed));
  371. tween(layer[get(cbname)].scrollarea.y, get(centeritem_y), get(cb.open_close_speed), default, layer[get(cbname)].scrollarea.update(); );
  372. <!-- special html5/flash case:
  373. rotating textfields (the marker symbol here) are not possible in
  374. flash (a flashplayer limitation), so use a rotated symbol instead.
  375. -->
  376. if(device.html5,
  377. tween(layer[get(cbname)].marker.rotate, 90, get(cb.open_close_speed));
  378. ,
  379. set(layer[get(cbname)].marker.html, '◀');
  380. );
  381. <!-- enable the scrollarea to allow the user to drag it -->
  382. set(cb.scrollarea.enabled, true);
  383. <!-- install a global onmousedown event to close the list when clicking at the pano -->
  384. set(events[combobox_xml_plugin_events].onmousedown, combobox_closelist() );
  385. </action>
  386. <!-- close the current open list -->
  387. <action name="combobox_closelist" scope="local">
  388. if(global.openedcombobox !== null,
  389. copy(cb, global.openedcombobox);
  390. delete(global.openedcombobox);
  391. <!-- clear the global onmousedown event -->
  392. set(events[combobox_xml_plugin_events].onmousedown, null);
  393. <!-- disable the dragging -->
  394. set(cb.scrollarea.enabled, false);
  395. <!-- closing animations -->
  396. calc(offset, cb.selecteditemindex*(cb.autosize_max_h + cb.margin));
  397. if(cb.ybackup !== null, tween(cb.y, get(cb.ybackup), get(cb.open_close_speed)));
  398. layer[get(cb.name)].scrollarea.stopscrolling();
  399. tween(layer[get(cb.name)].height, calc(2*cb.margin + cb.autosize_max_h), get(cb.open_close_speed));
  400. tween(layer[get(cb.name)].scrollarea.y, calc(-offset), get(cb.open_close_speed), default, layer[get(cb.name)].scrollarea.update(); );
  401. tween(layer[get(cb.name)].marker.y, calc(cb.margin + offset + cb.autosize_max_h/2), get(cb.open_close_speed));
  402. <!-- special html5/flash case: rotate marker or change symbol -->
  403. if(device.html5,
  404. tween(layer[get(cb.name)].marker.rotate, 0, get(cb.open_close_speed));
  405. ,
  406. set(layer[get(cb.name)].marker.html, '▼');
  407. );
  408. );
  409. </action>
  410. </krpano>