Calendar 类

全称	mx.controls.Calendar
命名空间	mx.controls
类	Calendar
继承层次结构	CalendarControl
源文件	~\mx\scripts\controls\Calendar.js

提供一个日历控件的类。

示例 1

以下是创建 Calendar 的示例。该示例将说明如何创建一个初始值为当前日期的 Calendar。

JavaScript 代码
`var calendar = new mx.controls.Calendar();`

示例 2

该示例将说明如何创建一个同时显示时间的 Calendar，并设置日期格式。

JavaScript 代码
`var calendar = new mx.controls.Calendar({ displayTime: true, formatString: "yyyy-mm-dd hh:mm:ss" });`

构造函数

名称	说明
Calendar()	构建 Calendar 类的新实例。

初始化函数

名称	说明
init()

方法

名称	说明
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
hide()	隐藏控件，设置控件不可见。
moveTo(p_left, p_top)	移动控件到指定位置。
navigateTo(p_date)	导航到指定的年月。
navigateTo(p_year, p_month)	导航到指定的年月。
navigateToNextMonth()	导航到下一个月。如果当前为 12 月，则导航到第二年的 1 月。
navigateToPrevMonth()	导航到上一个月。如果当前为 1 月，则导航到上一年的 12 月。
resizeTo(p_width, p_height)	重设控件的大小。
setBorder(p_border)	设置控件的边框样式。
setBottom(p_bottom)	设置 bottom 字段的值。
setCss(p_css)	设置 css 字段的值。
setCssClass(p_cssClass)	设置 cssClass} 字段的值
setDisplay(p_display)	设置 display 字段的值。
setDisplayTime(p_displayTime)	设置 displayTime 字段的值。该方法强制显示时间控件，不管 formatString 的值。建议使用 setFormatString 方法控制时间控件的显示。
setEnabled(p_enabled)	设置 Control.enabled 字段的值。
setFormatString(p_format)	设置 formatString 字段的值。
setHeight(p_height)	设置 height 字段的值。
setLeft(p_left)	设置 left 字段的值。
setPadding(p_padding)	设置控件的内边距。
setPosition(p_position)	设置 position 字段的值。
setRight(p_right)	设置 right 字段的值。
setTop(p_top)	设置 top 字段的值。
setValue(p_value, p_triggerEvent)	设置 value 字段的值。
setVisible(p_visible)	设置 visible 字段的值。
setWidth(p_width)	设置 width 字段的值。
show()	显示控件，设置控件可见。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。

字段

名称	说明
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。
displayTime	获取一个值，表示是否显示 timeEditor 对象。如果该值为 true，则显示；反之则不显示。请使用 setDisplayTime 方法设置该字段的值。该属性在初始化时是通过 setFormatString 决定，在实例化过后可以通过调用 setDisplayTime 强制显示或者隐藏时间控件。推荐使用 setFormatString 方法设置是否显示时间编辑器。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。
formatString	获取格式说明符字符，指示如何显示值。请使用 setFormatString 方法设置该字段的值。该字段的可选值包括: yyyy-MM yyyy-MM-dd yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss
height	获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。该字段的可选值包括: static relative absolute fixed
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
timeEditor	一个 TimeEditor 对象，表示显示在底部的时间控件。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
value	获取控件当前显示的日期和时间值。请使用 setValue 方法设置该字段的值。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width	获取控件的宽度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setWidth 方法设置该字段的值。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。

事件

名称	说明
onchanged	当该字段的值发生更改后将触发该事件。调用 setValue(p_value, true) 方法并成功更改字段值后会触发该事件。
ondateclick	点击日期某天时触发事件。

构造函数详细信息

Calendar() 方法

构建 Calendar 类的新实例。

初始化函数详细信息

init() 方法

继承自

mx.controls.Control.init

方法详细信息

contains($p_target) 方法

返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。

参数

$p_target
一个 JQuery 对象，或 JQuery 选择器对应的字符串（如“#container”），或 HTML DOM 元素。

继承自

mx.controls.Control.contains

dispose() 方法

释放对象运行时动态生成的内容（属性、方法、事件）。

继承自

mx.controls.Control.dispose

getContext() 方法

获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。

继承自

mx.controls.Control.getContext

getEl() 方法

获取控件容器对应的 HTML DOM 元素对象。

继承自

mx.controls.Control.getEl

hide() 方法

隐藏控件，设置控件不可见。

继承自

mx.controls.Control.hide

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

p_left
一个数字，表示 css 样式的 left 属性。
p_top
一个数字，表示 css 样式的 top 属性。

继承自

mx.controls.Control.moveTo

navigateTo(p_date) 方法

导航到指定的年月。

参数

p_date
一个 Date 对象，指定需要导航到的日期。

navigateTo(p_year, p_month) 方法

导航到指定的年月。

参数

p_year
一个整数（如 2011）表示年。当参数只有 p_year 时，它还可以表示 Date 和字符串（如 2011-03-01）形式的日期值。
p_month
一个整数表示月份值，一个处于 0 到 11 之间的整数，它代表 Date 对象中的月份值。这个整数并不等于按照惯例来表示月份的数字，而是要比按惯例表示的值小 1。例如 3 表示 4 月份。

navigateToNextMonth() 方法

导航到下一个月。如果当前为 12 月，则导航到第二年的 1 月。

navigateToPrevMonth() 方法

导航到上一个月。如果当前为 1 月，则导航到上一年的 12 月。

resizeTo(p_width, p_height) 方法

重设控件的大小。

参数

p_width
控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.resizeTo

setBorder(p_border) 方法

设置控件的边框样式。

参数

p_border
一个字符串，表示css样式的 border 属性。

继承自

mx.controls.Control.setBorder

setBottom(p_bottom) 方法

设置 bottom 字段的值。

参数

p_bottom
控件的下边界与父容器下边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setBottom

setCss(p_css) 方法

设置 css 字段的值。

参数

p_css
一个 JSON 对象，表示控件的 CSS 样式。

继承自

mx.controls.Control.setCss

setCssClass(p_cssClass) 方法

设置 cssClass} 字段的值

参数

p_cssClass
一个String 对象，样式classname

继承自

mx.controls.Control.setCssClass

setDisplay(p_display) 方法

设置 display 字段的值。

参数

p_display
css 样式的 display 属性。

继承自

mx.controls.Control.setDisplay

setDisplayTime(p_displayTime) 方法

设置 displayTime 字段的值。该方法强制显示时间控件，不管 formatString 的值。建议使用 setFormatString 方法控制时间控件的显示。

参数

p_displayTime

setEnabled(p_enabled) 方法

设置 Control.enabled 字段的值。

参数

p_enabled

继承自

mx.controls.Control.setEnabled

setFormatString(p_format) 方法

设置 formatString 字段的值。

参数

p_format

setHeight(p_height) 方法

设置 height 字段的值。

参数

p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.setHeight

setLeft(p_left) 方法

设置 left 字段的值。

参数

p_left
控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setLeft

setPadding(p_padding) 方法

设置控件的内边距。

参数

p_padding
一个字符串，表示css样式的 padding 属性。

继承自

mx.controls.Control.setPadding

setPosition(p_position) 方法

设置 position 字段的值。

参数

p_position
一个字符串，表示 css 样式的 position 属性。

继承自

mx.controls.Control.setPosition

setRight(p_right) 方法

设置 right 字段的值。

参数

p_right
控件的右边界与父容器右边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setRight

setTop(p_top) 方法

设置 top 字段的值。

参数

p_top
控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setTop

setValue(p_value, p_triggerEvent) 方法

设置 value 字段的值。

参数

p_value
一个 Date 类型或字符串形式的日期值。
p_triggerEvent
一个 Boolean 值，表示是否需要触发 onchanged 事件。如果该值为 true，则触发事件；反之则不触发。

setVisible(p_visible) 方法

设置 visible 字段的值。

参数

p_visible
一个 Boolean 值，表示控件是否可见。

继承自

mx.controls.Control.setVisible

setWidth(p_width) 方法

设置 width 字段的值。

参数

p_width
控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.

继承自

mx.controls.Control.setWidth

show() 方法

显示控件，设置控件可见。

继承自

mx.controls.Control.show

$(p_expression) 方法

该方法与 me.$e.find(p_expression) 等同。

参数

p_expression

继承自

mx.controls.Control.$

$wrap([p_obj]) 方法

返回一个 JQuery 对象。

参数

p_obj
可选的。默认值为“me.$e”。一个 JQuery 对象，或继承自 Control 的控件，或字符串，或 HTML DOM 元素。如果参数为 JQuery 对象，则返回本身；如果参数为继承自 Control 的控件，则返回控件的 $e 对象；如果参数为字符串，则返回以字符串为选择器的 JQuery 对象；如果参数为空，则返回控件本身的 $e 对象。

继承自

mx.controls.Control.$wrap

字段详细信息

alias 字段

获取或设置一个字符串，表示控件的别名。

继承自

mx.controls.Control.alias

border 字段

获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。

继承自

mx.controls.Control.border

bottom 字段

获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。

继承自

mx.controls.Control.bottom

cssClass 字段

指定css伪类名称，设置控件显示样式

继承自

mx.controls.Control.cssClass

display 字段

获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。

继承自

mx.controls.Control.display

displayTime 字段

获取一个值，表示是否显示 timeEditor 对象。如果该值为 true，则显示；反之则不显示。请使用 setDisplayTime 方法设置该字段的值。该属性在初始化时是通过 setFormatString 决定，在实例化过后可以通过调用 setDisplayTime 强制显示或者隐藏时间控件。推荐使用 setFormatString 方法设置是否显示时间编辑器。