一制作前的准备知识
Yahoo! Widget让我们拒绝单调, 拥有超酷的桌面.如果你想开发一个widget, 其实也很简单.只需要了解下面的内容就可以了:
1. 图形图像的制作和处理
2. Html或者xml的语法
3. JavaScript程序设计
如果你以前有过网页制作的经验,那对你来说,widget的制作没有任何门槛.只不过把以前的html的网页换成了按照widget的类似xml的语法描述的kon文件.对于一个widget来说,它的源程序由三种文件组成:一是图片文件,还有就是描述这些图片以及一些图元的布局的kon文件,第三就是实现我们的逻辑和功能的JavaScript的js文件.
注释: .kon 包含 Widget工具的主要代码。当用户双击Widget 时 Yahoo!Widget Engine 会首先找到这个文件,读取其中的内容。 .kon 包含了初始图片的位置,程序代码 (XML 或 eXtensible Markup Language),以及偏好设置等项目。有时候,尤其是在比较复杂的 Widget工具中,JavaScript 会保存在 .js 文件中。 |
kon的基础知识
其实kon其实就是一个xml文件,描述的方式都是标准的xml的格式的.下面是一些实际的例子:
文件头定义了xml的版本和编码
<?xml version="1.0" encoding="utf-8"?> |
接下来就是一个widget的定义.
<widget name="MyAlarmClock" version="3.0" minimumVersion="3.0"> … </widget> |
在一个widget中可以有多个窗口,可以定义多个window对象
<widget name="MyAlarmClock" version="3.0" minimumVersion="3.0"> <window name="win1"> … </window> <window name="win2"> … </window> </widget> |
另外,image对象既可以直接作为widget中的元素也可以做个window中的元素
<window name="winMain" visible="1" shadow="1"> <image name="imgBg"> <src>Resources/background.png</src> <hOffset>0</hOffset> <vOffset>0</vOffset> <opacity>200</opacity> </image> ... </window> |
其中src定义的是image的源文件的位置.通常放在Resources目录下. hOffset定义的是在父节点winMain中的水平位置.如果我们想为图片添加鼠标移上就变样子的效果,那我们就需要为image加入三个子元素:
<image name="imgName"> … <onMouseEnter> imgName _onMouseEnter();</onMouseEnter> <onMouseExit> imgName _onMouseUp();</onMouseExit> <onMouseDown> imgName onMouseDown();</onMouseDown> <onMouseUp> imgName _onMouseUp();</onMouseUp> </image> |
在onMouseEnter, onMouseUp, onMouseDown和onMouseUp时的响应函数中,将该image的src值重新设置一下.如: imgName.src=”new.jpg”;
textarea是文本输入框对象,可以按照下面的方式定义,至于其中的各个参数的意义,可以参考Yahoo! Widget的参考手册.
<textarea name="txtTime"> <hOffset>105</hOffset> <vOffset>60</vOffset> <lines>1</lines> <alignment>center</alignment> <size>14</size> <bgOpacity>0</bgOpacity> <editable>true</editable> <scrollbar>false</scrollbar> <onKeyPress>txtTime_onKeyPress();</onKeyPress> </textarea> |
这里要特别提出的是在上面的这个textarea的描述中有一句<onKeyPress>txtTime_onKeyPress();</onKeyPress>,这句是定义它在收到键盘事件的时候的响应函数为txtTime_onKeyPress.这个函数的定义是在js文件中.
2.widget的界面效果和素材
首先展示一下闹铃的界面:
其中,使用到的图片如下:
分别是一张背景图和三个按钮的不同状态(正常,鼠标移上时,鼠标按下时)的图片.这些素材的准备工作我就不在这里赘述.
3.代码编写
首先给出闹铃的kon文件内容:
界面方面,主要由四部分组成:一个背景图imgBg,两个按钮图imgTurn和imgChooseRing,以及一个文本输入框.另外我们要实现闹铃的功能,所以需要加入一个timer对象,控制播放音乐的时间.
现在我们来逐行解析:
第1行:定义xml的版本和编码
第2行:定义了widget的名字和使用的widget engine的版本
第3行:是否打开调试,这个选项对于我们制作和调试的时候非常有用,在制作过程中可以设置为on,当我们发布的时候设置为off
第4行:定义了widget在载入的时候需要装载的javascript源文件,也就是实现我们程序逻辑的js文件.
第6行:定义了一个timer对象,用于控制闹铃.初始的时候它的ticking设置为false就说明它并不开始计时,
第8行:timer对象在onTimerFired的时候响应的函数是alarm,也就是震铃.此事件的意思就是描述timer对象在被激发的时候的响应行数.
第11行:定义了一个window对象,其实在本程序中只是用到一个window,但是出于对以后的扩张的考虑,即使只有一个窗口的时候,也应该定义window.
第12行-17行:定义了image,实际上这个image就是窗体实际上的背景图.
第19行-29行:定义了用于输入闹钟时间的文本框,它只允许输入一行,它的onKeyPress的响应事件是txtTime_onKeyPress();
第31行-39行:定义了”打开”/”关闭”闹钟的图片按钮,实际上就只是一个image对象,通过为它设置不同的src,就可以达到按钮的效果.
第31行-39行:定义了”选择闹铃”的图片按钮,它也是一个image对象,通过为它设置不同的src,就可以达到按钮的效果.点击它之后的响应事件是ChooseRing(),会弹出一个选择文件的对话框.可以选择硬盘上的mp3和wav文件.
下面是funcitons.js中函数的一些摘录:
var gbAlarmOn = false; // 闹铃是否已打开
// 打开/关闭闹钟, “打开”被按下以后,会调用setAlarm函数去设置闹铃
function Turn() { gbAlarmOn = !gbAlarmOn; if (gbAlarmOn) { imgTurn.src = 'Resources/turnoff-normal.png'; txtTime.editable = false; txtTime.color = "#ff0000"; setAlarm(); } else { imgTurn.src = 'Resources/turnon-normal.png'; txtTime.editable = true; txtTime.color = "#000000"; } }; |
// 设置闹钟,计算当前时候和文本框中事件的差,如果小于当前事件,那么就提示出错.
function setAlarm() { var time = txtTime.data.split(":");
if (time.length != 2 || time[0].length > 2 || time[1].length > 2) { // 时间的输入格式不正确 alert("Error occurs when input, please input in format: /"hh:mm/"."); } else { var now = new Date(); var AlarmHour = parseInt(time[0]); var AlarmMinute = parseInt(time[1]);
// 计算时间 var minus = AlarmHour*60 + AlarmMinute - now.getHours() * 60 - now.getMinutes(); if (minus <= 0) { alert("Wrong time inputed!"); Turn(); } else { // 闹钟设置为 AlarmHour : AlarmMinute timerAlarm.interval = minus*60; timerAlarm.ticking = true; } } }; |
// 选择铃声的音乐,调用widget engine的系统函数chooseFile
function ChooseRing() { // 显示选择文件的对话框 file = chooseFile(new Array(".mp3", "wav")); if (file) gstrRing = file; }; |
// 闹铃,播放音乐
function ring() { // 停止timer timerAlarm.ticking = false;
// 关闭闹钟 Turn();
if (gstrRing) { // 播放铃音 play(gstrRing, true); } else { // 如果没有设置铃声,那就蹦出个alert alert("Time out!"); } }; |
// 当在输入框中键入字符时,输入框只接受数字以及冒号,并且总长度不能超过5
function txtTime_onKeyPress() { var key = system.event.key; if ( key.charCodeAt(0) < '0' || key.charCodeAt(0) > ':' || txtTime.data.length >= 5) { txtTime.rejectKeyPress(); } }; |
// "打开","关闭"的mouseEnter事件
function imgTurn_onMouseEnter() { if (!gbAlarmOn) {//如果当前是”打开”按钮 imgTurn.src = 'Resources/turnon-enter.png'; } else { imgTurn.src = 'Resources/turnoff-enter.png'; } }; |
// "打开","关闭"的mouseDown事件
function imgTurn_onMouseDown() { if (!gbAlarmOn) {//如果当前是”打开”按钮 imgTurn.src = 'Resources/turnon-down.png'; } else { imgTurn.src = 'Resources/turnoff-down.png'; } }; |
// "打开","关闭"的mouseUp事件
function imgTurn_onMouseUp() { if (!gbAlarmOn) {//如果当前是”打开”按钮 imgTurn.src = 'Resources/turnon-normal.png'; } else { imgTurn.src = 'Resources/turnoff-normal.png'; } }; |
目录结构:
按照widget的目录格式规范,将kon文件放在Contents目录之下.资源文件则放在Contents/Resources目录下
打包方法
首先你需要安装有winzip或者winrar软件.打包的过程其实就是一个创建压缩包的过程.本文中,我使用的winrar,方法如下:在MyAlarmClock.widget目录的图标上右键,选择菜单中的”添加到档案文件”,然后将档案文件类型选择为zip,然后确认即可.
打包完成之后,将zip文件移到另外的地方,然后把后缀.zip去掉后的文件MyAlarmClock.widget就是我们做成的widget的了
四.运行时的截图
4.1开动闹铃后,文本框中文字变红并且不可以编辑
4.2关闭闹铃后,文本框中文字又恢复为黑色,并且可以编辑.
4.3选择铃声
结束语
widget的制作就是这么简单,快点动手吧!如果你对JavaScript不是很熟悉,推荐你看《JavaScript Bible》.如果你对xml不熟悉,推荐浏览w3schools.com