My97DatePicker使用说明文档

一. 简介

1. 简介

目前的版本是:4.2 正式版 发布于2008-12-03

2. 注意事项

• My97DatePicker目录是一个整体,不可破坏里面的目录结构,也不可对里面的文件改名,可以改目录名
• My97DatePicker.htm是必须文件,不可删除
• 各目录及文件的用途:
  WdatePicker.js 配置文件,在调用的地方仅需使用该文件
  config.js 语言和皮肤配置文件
  calendar.js 日期库主文件)
  My97DatePicker.htm 临时页面文件,不可删除
  目录lang 存放语言文件
  目录skin 存放皮肤的相关文件
• 当WdatePicker.js里的属性:$wdate=true时,在input里加上class="Wdate"就会在选择框右边出现日期图标,如果您不喜欢这个样式,可以把class="Wdate"去掉,另外也可以通过修改skin目录下的WdatePicker.css文件来修改样式

3. 支持的浏览器

IE 6.0+ , Firefox 2.0+ , Opera 9.5+ , Safari 3.0+

二. 功能及示例

1. 常规功能

1. 1.           支持多种调用模式

除了支持常规在input单击或获得焦点调用外,还支持使用其他的元素如:<img><div>等触发WdatePicker函数来调用弹出日期框

示例1-1-1 常规调用

<input id="d11" type="text" onClick="WdatePicker()"/>

示例1-1-2 图标触发

<input id="d12" type="text"/>
<img onclick="WdatePicker({el:$dp.$('d12')})" src="../skin/datePicker.gif" width="16" height="22" align="absmiddle">
注:$dp.$ 相当于 document.getElementById
$dp.$ 的详细用法可以参考内置函数

1. 2.           下拉,输入,导航选择日期

年月时分秒输入框都具备以下三种特性
1. 通过导航图标选择


2. 直接使用键盘输入数字


3. 直接从弹出的下拉框中选择


另:年份输入框有智能提示功能,当用户连续点击同一个导航按钮5次时,会自动弹出年份下拉框

1. 3.           支持周显示

可以通过配置isShowWeek属性决定是否限制周,并且在返回日期的时候还可以通过自带的自定义事件和API函数返回选择的周

 

示例1-2-1 周显示简单应用

<input id="d121" type="text" onfocus="WdatePicker({isShowWeek:true})"/>

示例1-2-2 利用onpicked事件把周赋值给另外的文本框

   您选择了第 (W格式)周, 另外您可以使用WW格式: 周
<input type="text" class="Wdate" id="d122" onFocus="WdatePicker({isShowWeek:true,onpicked:function() {$dp.$('d122_1').value=$dp.cal.getP('W','W');$dp.$('d122_2').value=$dp.cal.getP('W','WW');}})"/>

onpicked 用法详见自定义事件
$dp.cal.getP 用法详见内置函数

1. 4.           只读开关,高亮周末功能

设置readOnly属性 true 或 false 可指定日期框是否只读
设置highLineWeekDay属性 ture 或 false 可指定是否高亮周末

1. 5.           操作按钮自定义

清空按钮和今天按钮,可以根据需要进行自定义,它们分别对应 isShowClear 和 isShowToday 默认值都是true

示例1-5 禁用清空功能

最好把readOnly置为true,否则即使隐藏了清空按钮,用户依然可以在输入框里把值delete掉

<input class="Wdate" type="text" id="d15" onFocus="WdatePicker({isShowClear:false,readOnly:true})"/>

1. 6.           自动选择显示位置

当控件处在页面边界时,它会自动选择显示的位置,所以没有必要担心弹出框会被页面边界遮住的问题了.

1. 7.           自定义弹出位置

当控件处在页面边界时,它会自动选择显示的位置.此外你还可以使用position参数对弹出位置做调整.

 

示例1-6 通过position属性,自定义弹出位置

使用positon属性指定,弹出日期的坐标为{left:100,top:50}

<input class="Wdate" type="text" id="d16" onfocus="WdatePicker({position:{left:100,top:50}})"/>

position属性的详细用法详见属性表

2. 特色功能

1. 1.           平面显示

日期控件支持平面显示功能,只要设置一下eCont属性就可以把它当作日历来使用了,无需触发条件,直接显示在页面上

 

示例2-1 平面显示演示

<script>
function d533_focus(element){
var clearingFunc = function(){ if(!confirm('日期框的值为:'+this.value+', 确实要清空吗?')) return true; }
var clearedFunc = function(){ alert('日期框已被清空'); }
WdatePicker({el:element,onclearing:clearingFunc,oncleared:clearedFunc})
}
</script>
<input type="text" class="Wdate" id="d533" onFocus="d533_focus(this)"/>

6. 快速选择功能

此功能允许指定5个最常用的日期,可以方便用户选择,如果不指定,系统将自动生成
相关属性:
qsEnabled 是否启用快速选择功能
quickSel 快速选择数据,可以传入5个快速选择日期,日期格式同min/maxDate

注意:
日期格式必须与 realDateFmt realTimeFmt 相匹配
除了使用静态的日期值以外,还可以使用动态参数(如:%y,%M分别表示当前年和月)

示例6-1 传入2个静态日期

<input class="Wdate" type="text" onfocus="WdatePicker({dateFmt:'yyyy年MM月dd日',qsEnabled:true,quickSel:['2000-1-10','2000-2-20']})"/>

注意:当传入的数据不足5个时,系统将自动补全

示例6-2 传入2个动态日期,1个静态日期

<input type="text" class="Wdate" onFocus="WdatePicker({dateFmt:'yyyy年MM月dd日',qsEnabled:true,quickSel:['2000-10-01','%y-%M-01','%y-%M-%ld']})"/>

注意:当传入的数据不足5个时,系统将自动补全

三. 配置说明

1. 属性配置

1. 1.           属性表

属性	类型	默认值	说明
静态属性:只能在WdatePicker.js中配置,一般情况下,不建议您修改静态属性的值
$wdate	bool	true	是否自动引入Wdate类 设置为true时,可直接在引入WdatePicker.js的页面里使用 class="Wdate" Wdate可在skin目录下的WdatePicker.css文件中定义 建议使用默认值
$dpPath	string	''	是否显示指定程序包的绝对位置,一般情况下为空即可(程序自动创建),该属性是为防止极其少数的情况下程序创建出错而设置的 设置方法: 如果,程序包所在http中的地址为 http://localhost/proName/My97DatePicker/ 则 $dpPath = '/proName/My97DatePicker/'; 建议使用默认值
可配置属性:可以在WdatePicker方法是配置
el	Element 或 String	null	指定一个控件或控件的ID,必须具有value或innerHTML属性(如input,textarea,span,div,p等标签都可以),用户存储日期显示值(也就是dateFmt格式化后的值)
vel	Element 或 String	null	指定一个控件或控件的ID,必须具有value属性(如input),用于存储真实值(也就是realDateFmt和realTimeFmt格式化后的值)
position	object	{}	日期选择框显示位置 注意:坐标默认单位是px,是相对当前框架坐标(不受滚动条),left属性只接受数字,top属性除接受数字外还可以接受 'above' 上方显示, 'under' 下方显示, 'auto' 系统根据页面大小自动选择(默认) 如: {left:100,top:50}表示固定坐标[100,50] {top:50}表示横坐标自动生成,纵坐标指定为 50 {left:100}表示纵坐标自动生成,横坐标指定为 100 {top:'above'}表示上方显示 {top:'under'}表示下方显示 请参考示例
lang	string	'auto'	当值为'auto'时 自动根据客户端浏览器的语言自动选择语言 当值为 其他 时 从langList中选择对应的语言 你可以参考语言配置
skin	string	'default'	皮肤名称 默认自带 default和whyGreen两个皮肤 另外如果你的css够强的话,可以自己做皮肤 你可以参考皮肤配置
dateFmt	string	'yyyy-MM-dd'	日期显示格式 你可以参考自定义格式
realDateFmt	string	'yyyy-MM-dd'	计算机可识别的,真正的日期格式 无效日期设置(disabledDates),最大日期(maxDate),最小日期(minDate)以及快速日期都必须与它们相匹配 建议使用默认值
realTimeFmt	string	'HH:mm:ss'
realFullFmt	string	'%Date %Time'
minDate	string	'1900-01-01 00:00:00'	最小日期(注意要与上面的real日期相匹配)
maxDate	string	'2099-12-31 23:59:59'	最大日期(注意要与上面的real日期相匹配)
startDate	string	''	起始日期,既点击日期框时显示的起始日期 为空时,使用今天作为起始日期(默认值) 否则使用传入的日期作为起始日期(注意要与上面的real日期相匹配) 你可以参考起始日期示例
isShowWeek	bool	false	是否显示周 你可以参考周显示示例
highLineWeekDay	bool	true	是否高亮显示 周六 周日
isShowClear	bool	true	是否显示清空按钮
isShowToday	bool	true	是否显示今天按钮
isShowOthers	bool	true	为true时,第一行空白处显示上月的日期，末行空白处显示下月的日期,否则不显示
readOnly	bool	false	是否只读
errDealMode	int	0	纠错模式设置 可设置3中模式 0 - 提示 1 - 自动纠错 2 - 标记
autoPickDate	bool	null	为false时 点日期的时候不自动输入,而是要通过确定才能输入 为true时 即点击日期即可返回日期值 为null时(推荐使用) 如果有时间置为false 否则置为true
qsEnabled	bool	true	是否启用快速选择功能
quickSel	Array	null	快速选择数据,可以传入5个快速选择日期 注意:日期格式必须与 realDateFmt realTimeFmt realFullFmt 相匹配 你可以参考快速选择示例
disabledDays	Array	null	可以使用此功能禁用周日至周六所对应的日期 0至6 分别代表 周日至周六 你可以参考无效天示例
disabledDates	Array	null	可以使用此功能禁用所指定的一个或多个日期 你可以参考无效日期示例
opposite	bool	false	默认为false, 为true时,无效天和无效日期变成有效天和有效日期 你可以参考有效天与有效日期示例
onpicking	function	null	此四个参数为事件参数 你可以参考自定义事件示例
onpicked	function	null
onclearing	function	null
oncleared	function	null

1. 2.           配置全局默认值

通过配置WdatePicker.js的属性可以避免每次调用都传入配置值,为变成带来很多方便.
在默认情况下My97为每个属性都配置了默认值,这些默认值都可以在WdatePicker.js中修改的
你可以根据你个人的喜好更改这些值

比如你比较不喜欢默认的皮肤default 而更喜欢 whyGreen 这个皮肤,
你可以直接在WdatePicker.js把skin值改为 whyGreen
这样,你就不必每次调用控件的时候都传入 skin:'whyGreen' 了
你学会了吗?

1. 3.           配置单个控件

在控件里面你可以使用 onfocus 或 onclick 事件来调用WdatePicker函数来触发日期控件
WdatePicker({})其中{}中的内容都是只对当前实例有效,你可以任意配置属性表里有的所有属性
你可以随意的组合这些属性,达到你的需求
My97日期控件在这方面是做得非常灵活的.

1. 4.           多套配置快速切换

您可以设置多个WdatePicker.js文件,如 cn_WdatePicker.js,en_WdatePicker.js,simple_WdatePicker.js等
在不同的页面引入不同的 WdatePicker.js 达到配置快速切换的目的.
注意:文件必须以 _WdatePicker.js(大小写不限制) 为后缀,形如 <yourname>_WdatePicker.js

2. 语言配置

1. 1.           语言列表

My97DatePicker目录下有个config.js,里面有段代码:
var langList =
[
{name:'en', charset:'UTF-8'},
{name:'zh-cn', charset:'gb2312'},
{name:'zh-tw', charset:'GBK'}
];

这就是语言列表,每个项有name和charset两个属性.
name 表示语言的名称(必须与浏览器的语言字符串命名相同),在配置的时候,lang属性只能是配置列表里面已有的项,否则将自动返回第一项
charset 表示对应语言目录下的js文件所对应的编码格式

1. 2.           语言安装说明

分两步轻松实现:
1 将语言文件拷贝到 lang 目录
2 打开 config.js 配置语言列表

3. 皮肤配置

1. 1.           皮肤列表

My97DatePicker目录下有个config.js,里面有段代码:
var skinList =
[
{name:'default', charset:'gb2312'},
{name:'whyGreen', charset:'gb2312'},
{name:'blue', charset:'gb2312'},
{name:'simple', charset:'gb2312'}
];

这就是皮肤列表,每个项有name和charset两个属性.
name 表示皮肤的名称,在配置的时候,skin属性只能是配置列表里面已有的项,否则将自动返回第一项
charset 表示对应皮肤目录下的css文件:datepicker.css所对应的编码格式

1. 2.           皮肤安装说明

分两步轻松实现:
1 将皮肤文件包拷贝到 skin 目录
2 打开 config.js 配置皮肤列表

注意:安装过多的皮肤会影响效率,一般5个以下比较适宜

四. 如何使用

1. 在使用该日期控件的文件中加入JS库(仅这一个文件即可,其他文件会自动引入,请勿删除或改名), 代码如下 <script language="javascript" type="text/javascript" src="datepicker/WdatePicker.js"></script>
注:src="datepicker/WdatePicker.js" 请根据你的实际情况改变路径

2. 加上主调函数 WdatePicker
关于 WdatePicker 的用法:

如果您是新手,对js还不是很了解的话一定要多看看这份文档
基本上每一个演示的示例下面都有相关代码,并且 关键属性用蓝字标出,关键值用红字标出 应该很容易看明白

如果您有一定的水准
希望能从头到尾把功能介绍好好看一遍,这样大部分功能你都会用了

如果您是高手
建议您通读配置说明和内置函数

五. 内置函数

函数名	返回值类型	作用域	参数	描述
$dp.$	Element	全局	el [string]: 对象的ID	相当于document.getElementById 参考 示例 1-1-2
$dp.show	void	全局	无	显示日期选择框
$dp.hide	void	全局	无	隐藏日期选择框
$dp.$D	String	全局	id [string]: 对象的ID arg [object]: 日期差量,可以设置成 {y:[值],M:[值],d:[值],H:[值],m:[值],s:[值]} 属性 y,M,d,H,m,s 分别代表 年月日时分秒 {M:3,d:7} 表示 3个月零7天 {d:1,H:1} 表示1天多1小时	将id对应的日期框中的日期字符串,加上定义的日期差量,返回使用real格式化后的日期串 参考 示例 4-3-2
$dp.$DV	String	全局	v [string]: 日期字符串 arg [object]: 同上例的arg	将传入的日期字符串,加上定义的日期差量,返回使用real格式化后的日期串 参考 示例 4-3-3
以下函数只在事件自定义函数中有效
$dp.cal.getP	String	事件function	p [string]: 属性名称 yMdHmswWD分别代表年,月,日,时,分,秒,星期(0-6),周(1-52),星期(一-六) f [string]: format 格式字符串 设置方法参考 1.4 自定义格式	返回所指定属性被格式字符串格式化后的值[单属性] 参考 示例 1-2-2
dp.cal.getDateStr	String	事件function	f [string]: 格式字符串,为空时使用dateFmt	返回所指定属性被格式字符串格式化后的值[整个值]
完善中	完善中	完善中	完善中	完善中

六. 疑难解答

任何问题,请先参考 技术支持
如果找不到答案,您可以直接在blog留言,或者通过下面的联系方式与我联系

七. 联系My97

* 如果您在使用过程中遇到问题,或者有更好的建议
* 欢迎您访问
* BLOG: http://my97.cnblogs.com
* MAIL: [email protected]
* 有问题在我blog留言或给我Email吧,最好先仔细看说明,很多问题都是因为没有仔细看说明导致的