Wizard 类

[方法]、 [字段]、 [事件]

全称	mx.containers.Wizard
命名空间	mx.containers
类	Wizard
继承层次结构	WizardControl
源文件	~\mx\scripts\containers\Wizard.js

提供向导控件。示例及其他信息请参见 WizardStep 和 WizardWindow 类。

构造函数

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

初始化函数

名称	说明
init()	初始化方法。执行设置样式并初始化属性等操作。

方法

名称	说明
appendStep(p_step)	向 steps 字段的集合中追加一个步骤。
appendSteps(p_steps)	向 steps 字段的集合中追加一组步骤。
cancel()	取消当前向导。当用户点击“取消”按钮时将执行该方法。该方法将依次触发 oncancelled 事件。
canFinish()	获取一个 Boolean 值，表示是否允许用户完成该向导。
canMoveBack()	获取一个 Boolean 值，表示当前向导是否允许用户返回到上一步。
canMoveNext()	获取一个 Boolean 值，表示当前向导是否允许用户前进到下一步。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
finish()	完成当前向导。当用户点击“完成”按钮时将执行该方法。该方法将依次触发 onfinished 事件。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
hide()	隐藏控件，设置控件不可见。
moveBack()	将当前向导移到上一个步骤。当用户点击“上一步”按钮时将执行该方法。请参见 Wizard.moveTo 方法。
moveNext()	将当前向导移到下一个步骤。当用户点击“下一步”按钮时将执行该方法。请参见 Wizard.moveTo 方法。
moveTo(p_step)	将当前向导移到指定的步骤。该方法将依次触发：当前步骤的 WizardStep.onstepchanging 事件。当前步骤的 WizardStep.ondeactivate 事件。 p_step 参数指定的下一步骤的 WizardStep.onactivate 事件。向导控件的 Wizard.onstepchanged 事件。
moveTo(p_step, [p_moveBack])	将当前向导移到指定的步骤。该方法将依次触发：当前步骤的 WizardStep.onstepchanging 事件。当前步骤的 WizardStep.ondeactivate 事件。 p_step 参数指定的下一步骤的 WizardStep.onactivate 事件。向导控件的 Wizard.onstepchanged 事件。
resizeTo(p_width, p_height)	重设控件的大小。@param p_width 控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
setBorder(p_border)	设置控件的边框样式。@param p_border 一个字符串，表示css样式的 border 属性。
setBottom(p_bottom)	设置 bottom 字段的值。@param p_bottom 控件的下边界与父容器下边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setCss(p_css)	设置 css 字段的值。 @param p_css 一个 JSON 对象，表示控件的 CSS 样式。
setCssClass(p_cssClass)	设置 cssClass 字段的值 @param p_cssClass 一个String 对象，样式classname
setDisplay(p_display)	设置 display 字段的值。@param p_display css 样式的 display 属性。
setEnabled(p_enabled)	设置 enabled 字段的值。
setHeight(p_height)	设置 height 字段的值。注：子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
setLeft(p_left)	设置 left 字段的值。 @param p_left 控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setPadding(p_padding)	设置控件的内边距。@param p_padding 一个字符串，表示css样式的 padding 属性。
setPosition(p_position)	设置 position 字段的值。@param p_position 一个字符串，表示 css 样式的 position 属性。
setRight(p_right)	设置 right 字段的值。@param p_right 控件的右边界与父容器右边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setTop(p_top)	设置 top 字段的值。 @param p_top 控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setVisible(p_visible)	设置 visible 字段的值。@param p_visible 一个 Boolean 值，表示控件是否可见。
setWidth(p_width)	设置 width 字段的值。@param p_width 控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.
show()	显示控件，设置控件可见。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。

字段

名称	说明
activeStep	获取一个 WizardStep 对象，表示当前正在进行的步骤。请使用 moveTo 方法设置 activeStep 步骤。另请参见 WizardStep.activate 方法。
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay方法设置该字段的值。
enableBrowserContextMenu	获取或初始化设置是否允许浏览器默认的上下文菜单。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。@default true
eTag	获取控件的标签。
height	获取组件的高度，可以是数字（如 500）、字符串（如“500px”或“50%”）。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	获取控件位置样式值。请使用 setPosition 方法设置该字段的值。该字段的可选值包括: relative absolute
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
steps	获取一个集合，包含当前向导控件中的所有步骤（WizardStep）。
stepToggleMode	获取或设置向导页的切换模式。可设的值为。 detach 表示切换为非选中状态时将向导页体从当前 DOM 上下文中移除。 hide 表示切换为非选中状态时将向导页体从当前 DOM 上下文中隐藏。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。@default true
width	获取组件的宽度，可以是数字（如 500）、字符串（如“500px”或“50%”）。
$body	一个表示向导主体部分的 JQuery 对象。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。

事件

名称	说明
oncancelled	当用户在向导中点击“取消”按钮或在程序中调用 cancel 方法后，将触发该事件。
onfinished	当用户在向导中点击“完成”按钮或在程序中调用 finish 方法后，将触发该事件。
onstepchanged	当用户在向导中点击“上一步”、“下一步”按钮或在程序中调用 moveTo 方法后，将触发该事件。
onstepchanging	当用户在向导中点击“上一步”、“下一步”按钮或在程序中调用 moveTo 方法时，将触发该事件。

构造函数详细信息

Wizard() 方法

构建 Wizard 类的新实例。

初始化函数详细信息

init() 方法

初始化方法。执行设置样式并初始化属性等操作。

继承自

mx.controls.Control.init

方法详细信息

appendStep(p_step) 方法

向 steps 字段的集合中追加一个步骤。

参数

p_step
一个 WizardStep 对象，表示需要追加的步骤。

appendSteps(p_steps) 方法

向 steps 字段的集合中追加一组步骤。

参数

p_steps
一个 WizardStep 对象集合。

cancel() 方法

取消当前向导。当用户点击“取消”按钮时将执行该方法。该方法将依次触发 oncancelled 事件。

canFinish() 方法

获取一个 Boolean 值，表示是否允许用户完成该向导。

canMoveBack() 方法

获取一个 Boolean 值，表示当前向导是否允许用户返回到上一步。

canMoveNext() 方法

获取一个 Boolean 值，表示当前向导是否允许用户前进到下一步。

contains($p_target) 方法

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

参数

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

继承自

mx.controls.Control.contains

dispose() 方法

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

继承自

mx.controls.Control.dispose

finish() 方法

完成当前向导。当用户点击“完成”按钮时将执行该方法。该方法将依次触发 onfinished 事件。

getContext() 方法

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

继承自

mx.controls.Control.getContext

getEl() 方法

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

继承自

mx.controls.Control.getEl

hide() 方法

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

继承自

mx.controls.Control.hide

moveBack() 方法

将当前向导移到上一个步骤。当用户点击“上一步”按钮时将执行该方法。请参见 Wizard.moveTo 方法。

moveNext() 方法

将当前向导移到下一个步骤。当用户点击“下一步”按钮时将执行该方法。请参见 Wizard.moveTo 方法。

moveTo(p_step) 方法

将当前向导移到指定的步骤。

该方法将依次触发：

当前步骤的 WizardStep.onstepchanging 事件。
当前步骤的 WizardStep.ondeactivate 事件。
p_step 参数指定的下一步骤的 WizardStep.onactivate 事件。
向导控件的 Wizard.onstepchanged 事件。

参数

p_step
指定的步骤，该参数可以是表示步骤的名称的一个字符串，或一个表示步骤序号的数字（从 0 开始计数），或一个 WizardStep 对象。

继承自

mx.controls.Control.moveTo

moveTo(p_step, [p_moveBack]) 方法

将当前向导移到指定的步骤。

该方法将依次触发：

当前步骤的 WizardStep.onstepchanging 事件。
当前步骤的 WizardStep.ondeactivate 事件。
p_step 参数指定的下一步骤的 WizardStep.onactivate 事件。
向导控件的 Wizard.onstepchanged 事件。

参数

p_step
指定的步骤，该参数可以是表示步骤的名称的一个字符串，或一个表示步骤序号的数字（从 0 开始计数），或一个 WizardStep 对象。
p_moveBack
可选的。默认值为“false”。指定向导移动的方向。如果是后退移动，则必须指定为 true。

继承自

mx.controls.Control.moveTo

resizeTo(p_width, p_height) 方法

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

参数

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

继承自

mx.controls.Control.resizeTo

setBorder(p_border) 方法

设置控件的边框样式。@param p_border 一个字符串，表示css样式的 border 属性。

参数

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

继承自

mx.controls.Control.setBorder

setBottom(p_bottom) 方法

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

参数

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

继承自

mx.controls.Control.setBottom

setCss(p_css) 方法

设置 css 字段的值。 @param p_css 一个 JSON 对象，表示控件的 CSS 样式。

参数

p_css
一个 JSON 对象，表示控件的 CSS 样式。 {@exclude mx.datacontrols.ScrollBar}

继承自

mx.controls.Control.setCss

setCssClass(p_cssClass) 方法

设置 cssClass 字段的值 @param p_cssClass 一个String 对象，样式classname

参数

p_cssClass
一个String 对象，样式classname {@exclude mx.datacontrols.ScrollBar}

继承自

mx.controls.Control.setCssClass

setDisplay(p_display) 方法

设置 display 字段的值。@param p_display css 样式的 display 属性。

参数

p_display
css 样式的 display 属性。

继承自

mx.controls.Control.setDisplay

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

p_enabled
: 布尔值 true：控件可用反之不可用

继承自

mx.controls.Control.setEnabled

setHeight(p_height) 方法

设置 height 字段的值。注：子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

参数

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

继承自

mx.controls.Control.setHeight

setLeft(p_left) 方法

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

参数

p_left
控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自

mx.controls.Control.setLeft

setPadding(p_padding) 方法

设置控件的内边距。@param p_padding 一个字符串，表示css样式的 padding 属性。

参数

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

继承自

mx.controls.Control.setPadding

setPosition(p_position) 方法

设置 position 字段的值。@param p_position 一个字符串，表示 css 样式的 position 属性。

参数

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

继承自

mx.controls.Control.setPosition

setRight(p_right) 方法

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

参数

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

继承自

mx.controls.Control.setRight

setTop(p_top) 方法

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

参数

p_top
控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自

mx.controls.Control.setTop

setVisible(p_visible) 方法

设置 visible 字段的值。@param p_visible 一个 Boolean 值，表示控件是否可见。

参数

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

继承自

mx.controls.Control.setVisible

setWidth(p_width) 方法

设置 width 字段的值。@param p_width 控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.

参数

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 对象。