lhgcalendar.min.js jQuery日历插件

原文：http://www.canwin.net/common/lhgcalendar/_doc/api.html

应用到你的项目

如果您使用独立版本的lhgCalendar日历组件，您只需在页面head中引入lhgcore.lhgcalendar.min.js文件，3.0.0版本做了修改可以和jQuerya库同时引用，而且3.0.0版本的独立组件的lhgcore库做了极大的修改，专门为组件定制，压缩后才6K与组件合在一起总大小才不到15K，效率上得到很大提高，比引用jQuery快很多，但这里要注意如果你同时引用了jQuery库的话必须把$换成J，如果没引用jQuery库则可直接使用$。

<script type="text/javascript" src="lhgcore.lhgcalendar.min.js"></script>

如果您的页面中引入了jQuery库文件，您只需在页面head中再引入lhglhgcalendar.min.js文件即可，此时lhgCalendar组件将作为jQuery的一个插件使用，注意lhgcalendar.min.js要写到jQuery库文件的下面哟。

<script type="text/javascript" src="jQuery-1.7.1.min.js"></script>
<script type="text/javascript" src="lhgcalendar.min.js"></script>

组件提供全局默认配置参数读/写接口，如果您想修改组件的全局默认配置，按照以下方法设置即可(可选):

(function(config){
    config['extendDrag'] = true; // 注意，此配置参数只能在这里使用全局配置，在调用窗口的传参数使用无效
    config['lock'] = true;
    config['fixed'] = true;
    config['okVal'] = 'Ok';
    config['cancelVal'] = 'Cancel';
    // [more..]
})($.calendar.setting);

初始化参数列表

1. id：文本输入框的id

   类型：String
   默认：null
   说明：使用其他的元素如:<img><div>等来调用弹出日期框时一定要指定输入日期的文本框的id，注意id前一定要加#号，如：#cal

2. format：自定义日期格式

   类型：String
   默认：'yyyy-MM-dd'
   说明：yMdHms分别代表年月日时分秒，你可以任意组合这些元素来自定义你个性化的日期格式。请见下表：

   日期格式表

   格式	说明
   yy	将年份表示为二位数字。
   yyyy	将年份表示为四位数字。如果少于四位数，前面补零。
   M	将月份表示为从 1 至 12 的数字
   MM	同上，如果小于两位数，前面补零。
   d	将月中日期表示为从 1 至 31 的数字。
   dd	同上，如果小于两位数，前面补零。
   H	将小时表示为从 0 至 23 的数字。
   HH	同上，如果小于两位数，前面补零。
   m	将分钟表示为从 0 至 59 的数字。
   mm	同上，如果小于两位数，前面补零。
   s	将秒表示为从 0 至 59 的数字。
   ss	同上，如果小于两位数，前面补零。

   示例(只列出了常用的几种格式，如需要其它格式请自行设置)

   格式字符串	值
   yyyy-MM-dd HH:mm:ss	2008-03-12 19:20:00
   yy年M月	08年3月
   yyyyMMdd	20080312
   MM/dd/yyyy	03/12/2008

   动态变量表

   格式	说明
   %y	当前年
   %M	当前月
   %d	当前日
   %H	当前时
   %m	当前分
   %s	当前秒

3. noToday：是否包含今天

   类型：Boolean
   默认：false

4. btnBar：是否显示下面的按钮栏

   类型：Boolean
   默认：true

5. minDate：最小日期

   类型：String
   默认：null
   说明：注意格式要为 yyyy-MM-dd

6. maxDate：最大日期

   类型：String
   默认：null
   说明：注意格式要为 yyyy-MM-dd

7. targetFormat：目标文本框的日期格式

   类型：String
   默认：null
   说明：当有2个文本框之间进行日期范围限制时指来指定对应的文本框的日期格式

8. disWeek：无效周

   类型：String
   默认：null
   说明：可以使用此功能禁用周日至周六所对应的日期，多个周用,分开，如：'2,4'

9. disDate：无效日期

   类型：String
   默认：null
   说明：可以使用此功能禁用所指定的一个或多个日期

10. enDate：有效日期

    类型：Boolean
    默认：false
    说明：为true时,无效日期变成有效日期，一般和disDate配合使用

11. real：存储真实日期值的控件的ID

    类型：String
    默认：null
    说明：指定一个控件的ID,必须具有value属性(如input),用于存储真实值

12. onSetDate：点击某一日期时执行的回调函数

    类型：Function
    默认：null
    说明：当选择一个日期时点击这个日期时就会触发这个函数

13. zIndex：日历组件的z-index值

    类型：Number
    默认：1978

API函数接口列表

API接口列表：

1. show()：显示日历

   参数：无
   说明：显示日历组件

2. hide()：隐藏日历

   参数：无

3. getDate(type) ：获取指定格式的日期

   参数1：指定的日期格式 (y:返回年，M:返回月，d:返回日，H:返回小时，m:返回分钟，s:返回秒，date:返回年月日，格式yyyy-MM-dd，dateTime:返回年月日时分秒，格式yyyy-MM-dd HH:mm:ss)

4. $.calendar.formatDate(data,format) ：格式化日期

   参数1：date -- 要格式化的日期
   参数2：format -- 指定的格式

API属性接口列表：

1. inpE ：插入日期的文本框对象

   显示日期的文本框

2. DOM：日历的DOM对象

   通过此对象可以对日历DOM对象进行操作

日历的各种在线演示示例

jQuery方式和普通函数式

1. jQuery方式调用

   J(function(){
       J('#inp1').calendar();
   });
   

2. 普通函数方式调用

   function opcal(){
       J.calendar.Show();
   }
   //输入框的代码：
   <input class="runcode" id="inp2" onclick="opcal();"/>
   

下拉，输入，导航选择日期(年月输入框都具备以下三种特性)

1. 通过导航图标选择

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

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

常规功能使用演示

1. id参数(注意这里的id参数的值是左边输入框的id)，图标触发

   J('#img').calendar({ id:'inp3' });
   

    

2. 是否显示按钮栏

   J('#inp4').calendar({ btnBar:false });
   

3. 自动选择显示位置

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

4. 自定义格式(其它各种自定义格式请参阅 API参数控制接口)

   J('#inp5').calendar({ format:'yyyy年MM月dd日 HH时mm分ss秒' });
   

5. 取得系统可识别的日期值(重要)

   // 类似于 1999年7月5日 这样的日期是不能够被系统识别的,他必须转换为能够识别的类型如 1999-07-05 
   J('#inp6').calendar({ format:'yyyy年MM月dd日', real:'realInp' });
   
   // input文本框的代码是：
   <input class="runcode" id="inp6"/><input class="runcode" id="realInp" type="text"/>
   
   // 注意:在实际应用中,一般会把real指定为一个hidden控件,这里是为了把真实值展示出来,所以使用文本框
   // 关键属性: real 指定一个控件或控件的ID,必须具有value属性(如input),用于存储真实值
   

   真实的日期值是:

6. 自动纠错功能

   当日期框中的值不符合格式时,系统会尝试自动修复,显示当前日期。
   

日期范围限制

1. 静态限制

   // 限制日期的范围是 2011-04-10到2008-05-27 (注意minDate和maxDate的格式一定要是yyyy-MM-dd)
   J('#inp7').calendar({ minDate:'2011-04-10', maxDate:'2011-05-27' });
   

2. 动态限制(请参阅 API参数控制接口 里的动态变量表)

   // 只能选择今天以前的日期
   J('#inp8').calendar({ maxDate:'%y-%M-%d' });
   

3. 只能选择今天以后的日期

   J('#inp9').calendar({ minDate:'%y-%M-%d' });
   

4. 只能选择本年4月当前天到当前月的25号之间的日期

   J('#inp10').calendar({ minDate:'%y-04-%d', maxDate:'%y-%M-25' });
   

5. 前面的日期不能大于后面的日期

   // #inp12为一个#号加上后面输入框的id
   J('#inp11').calendar({ maxDate:'#inp12' });
   // #inp11为一个#号加上前面输入框的id
   J('#inp12').calendar({ minDate:'#inp11' });
   

   有效期从到

6. 前面的日期不能大于后面的日期(targetFormat参数示例)

   // #inp14为一个#号加上后面输入框的id
   J('#inp13').calendar({ maxDate:'#inp14', format:'yyyyMMdd' targetFormat:'yyyy年MM月dd日' });
   // #inp13为一个#号加上前面输入框的id
   J('#inp14').calendar({ minDate:'#inp13', format:'yyyy年MM月dd日', targetFormat:'yyyyMMdd' });
   注：如果目标文本框的日期格式不是'yyyy-MM-dd'的格式，则一定要加上targetFormat参数，指明目标文本框的日期格式
   

   有效期从到

7. 无效周(可以使用此功能禁用周日至周六所对应的日期,相关属性:disWeek (0至6 分别代表 周日至周六))

   // 前面的输入框代码(周六所对应的日期无效)
   J('#inp15').calendar({ disWeek:'6' });
   // 后面的输入框代码(周日和周四所对应的日期无效)
   J('#inp16').calendar({ disWeek:'0,4' });
   

     

无效日期(可以使用此功能禁用,所指定的一个或多个日期,只要你熟悉正则表达式,你可以尽情发挥)

1. 禁用 每个月份的 5日 15日 25日

   // '5$' 表示以 5 结尾 注意 $ 的用法 
   J('#inp17').calendar({ disDate:['5$'] });
   

2. 禁用 所有早于2000-01-01的日期

   J('#inp18').calendar({ disDate:['^19'] });
   

3. 禁用 2011-05-05 和 2011-05-24

   J('#inp19').calendar({ disDate:['2011-05-05','2011-05-24'] });
   

4. 禁用 2011-所有月份-04 和 2011-05-29

   J('#inp20').calendar({ disDate:['2011-..-04','2011-05-29'] });
   

5. 禁用 [2000至2008]-05-01 和 2011-05-29

   J('#inp21').calendar({ disDate:['200[0-8]-05-01','2011-05-29'] });
   

6. 禁用 所有年份和所有月份的第7天和今天

   J('#inp22').calendar({ disDate:['....-..-07','%y-%M-%d'] });
   

有效日期
使用无效日期可以很方便的禁用不可用的日期,但是在只需要启用少部分日期的情况下,有效日期的功能就非常适合了
关键属性: enDate 默认为false, 为true时,无效日期变成有效日期

1. 启用 每个月份的 5日 15日 25日

   J('#inp23').calendar({ disDate:['5$'], enDate:true });
   

自定义事件

1. 自定义事件

   如果你需要做一些附加的操作,你也不必担心,日期控件自带的自定义事件可以满足你的需求.此外,你还可以在自定义事件中调用提供的API库来做更多的运算和扩展,绝对可以通过很少的代码满足你及其个性化的需求.
   
   注意下面几个重要的指针,将对你的编程带来很多便利
   this: 指向日历对象实例，也就是J.calendar对象
   this.inpObj: 指向文本框
   this.cal: 指向日历控件对象
   
   注意:函数原型必须使用类似 function(dp){} 的模式,这样子,在函数内部才可以使用this
   

2. onSetDate事件

   J('#inp24').calendar({ onSetDate:function(){alert(this.inpObj.value);} });
   

3. getDateStr()用法

   // getDateStr的参数用法请参阅 API参数控制接口
   J('#inp25').calendar({ onSetDate:function(){alert('日期框原来的值为:'+this.inpObj.value+',要用新选择的值:'+this.getDateStr('date')+'覆盖吗?');} });
   

示例中各API接口的详细说明请参阅 API参数控制接口