文/玄魂
目錄
node-webkit學習(3)Native UI API概覽
前言
3.1 Native UI api概覽
Extended Window APIs
Menus
Platform Services
Tips
3.2 注意事項
3.3 EventEmitter
幾個月前，要開發一個簡易的展示應用，要求支持離線播放（桌面應用）和在線播放（web應用）。
當時第一想到的是flex，同一套代碼（或者只需少量的更改）就可以同時運行在桌面和瀏覽器上。由於很多展現效果要全新開發，我想到了impress.js(https://github.com/bartaz/impress.js/)。如果選擇impress.js，就意味着要將html5作為桌面應用，當時想到要封裝webkit，但是本人對這方面也不是很熟悉，時間也很有限，就又沿着這個方向搜索，找到了node-webkit(https://github.com/rogerwang/node-webkit)。
node-webkit解決了我通過html和js來編寫桌面應用的難題。
至於node-webkit的定義，按照作者的說法：
“ 基於node.js和chromium的應用程序實時運行環境，可運行通過HTML(5)、CSS(3)、Javascript來編寫的本地應用程序。node.js和webkit的結合體，webkit提供DOM操作，node.js提供本地化操作；且將二者的context完全整合，可在HTML代碼中直接使用node.js的API。”
Native UI API，是提供了在代碼中訪問、控制應用程序界面顯示的接口。和使用node.js模塊類似，想要訪問node-webkit的Native UI API，需要先加載“nw.gui”模塊。node-webkit的模塊命名遵循node.js規范，所以不必擔心產生沖突。
下面我們創建本文的示例程序。
先創建guidemo.html，內容如下：
<html>
<head>
</head>
<body>
<h1>Hello GUI</h1>
<script>
</script>
</body>
</html>
package.json內容如下：
{
"name": "gui-demo",
"main": "guidemo.html",
"nodejs":true,
"width":100,
"height":200,
"window": {
"title": "GUI DEMO",
"toolbar": true,
"width": 800,
"height": 600,
"resizable":true,
"show_in_taskbar":true,
"frame":true,
"kiosk":false
},
"webkit":{
"plugin":true
}
}
若要訪問native ui api，需要先加載“nw.gui”模塊，代碼如下：
var gui = require('nw.gui');
加載gui模塊之后，就可以像創建普通的javascript對象一樣，創建GUI元素了。例如，我們可以使用如下代碼創建一個菜單：
var menu = new gui.Menu({ title: '菜單' });
下面，我們按如下內容修改guidemo.html：
<html>
<head>
<title>gui</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body >
<h1>Hello GUI菜單</h1>
<script>
var gui = require('nw.gui');
var menubar = new gui.Menu({ type: 'menubar' });
var sub1 = new gui.Menu();
sub1.append(new gui.MenuItem({
label: '子菜單1',
click: function() {
var element = document.createElement('div');
element.appendChild(document.createTextNode('Test 1'));
document.body.appendChild(element);
}
}));
menubar.append(new gui.MenuItem({ label: '菜單1', submenu: sub1 }));
var win = gui.Window.get();
win.menu = menubar;
</script>
</body>
</html>
首先，通過
var gui = require('nw.gui');
加載nw.gui模塊。
隨后通過
var menubar = new gui.Menu({ type: 'menubar' });
創建了一個menubar類型的Menu，即菜單欄。有了菜單欄之后就可以向其中添加菜單了。我們創建了一個菜單“sub1”，通過添加MenuItem對象，添加該菜單的下拉選項，並定義了click事件。
隨后通過
menubar.append(new gui.MenuItem({ label: '菜單1', submenu: sub1 }));
將sub1添加為菜單1的子菜單。
目前為止，菜單項創建完畢，需要將其添加到當前窗口上。通過
var win = gui.Window.get();
獲取窗口對象，然后通過
win.menu = menubar;
設置窗口的菜單。
運行效果如下：
對於每個gui對象的屬性，比如title、label、 icon 和menu，可以直接通過對象去訪問和修改。比如下面的代碼：
menu.title = 'New Title';
remove、append 和 insert方法，在每個GUI對象上都可以使用，例如：
menu.append(new gui.MenuItem({ label: 'Im an item' }));
menu.removeAt(0);
子元素通常被存儲在items字段中，可以通過索引進行訪問:
for (var i = 0; i < menu.items.length; ++i) {
console.log('MenuItem', i, menu.items[i]);
}
在上面的示例代碼中，我們主要以menue為例進行介紹，native ui api大致可划分為如下的類別：
· Window
· Frameless Window
· Menu
· MenuItem
· Window menu
· App – 每一個應用都可以訪問的全局函數
· Clipboard – 剪貼板
· Tray – 狀態顯示與通知
· File dialogs-文件對話框
· Shell
· Handling files and arguments
· Show window after page is ready
· Minimize to tray
· Preserve window state between sessions
鄙視不標明出處的轉載，更多相關內容，歡迎訪問玄魂的博客www.xuanhun521.com(node webkit學習(2)基本結構和配置)
不要通過賦值的方式直接修改一個GUI對象，比如：
menu.items[0] = item
或者
item = new gui.MenuItem({})
想要替換一個元素，需要先remove再insert。
在調用gui api過程中出現的異常，目前node-webkit並沒有做處理，程序會直接崩潰。要小心重復刪除元素之類的操作。
刪除一個對象之后，要將其設置為null值，如：
var tray = new gui.Tray(...);
// blablabla...
// We are done with it
tray.remove();
tray = null; // This line is very important
Do not change UI types' prototype（沒明白具體指什么，望讀者告知）
在node-webkit中，每一個ui元素都從node.js的EventEmitter繼承而來，所以你可以用如下的方式監聽元素的實踐：
menuitem.on('click', function() {
console.log('Item is clicked');
});
本文內容主要來自node-webkit的官方英文文檔（https://github.com/rogerwang/node-webkit/wiki/API-Overview-and-Notices），做了適當的改編和調整。主要目的是從整體上認識Native UI API，同時了解基本用法。之后的文章，會對每一個類別的api做詳細的介紹。
更多相關內容，歡迎訪問玄魂的博客 www.xuanhun521.com
ps：nw.js，electron交流群 313717550