ImportExcelWizard 类

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

全称	mx.datacontrols.wizards.ImportExcelWizard
命名空间	mx.datacontrols.wizards
类	ImportExcelWizard
继承层次结构	ImportExcelWizardWizardWindowWindowViewPortContainerControl
源文件	~\mx\scripts\datacontrols\wizards\ImportExcelWizard.js

提供一个导入 Excel 的向导。请使用 WindowManager 创建。

构造函数

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

初始化函数

名称	说明
init()	初始化窗体。

方法

名称	说明
activate()	将当前窗体置为激活状态。在该方法中会自动调用 bringToFront 方法，并会触发 onactivate 事件。
addControl(p_control, p_islinebreak)	将 Control 对象添加到集合 controls 中。@param p_control 一个 Control 对象。 @param p_islinebreak 一个布尔值，表示添加新控件时是否先换行。
addControls(p_controls)	将一组 Control 对象添加到集合 controls 中。@param p_controls 一个 Control 控件数组。
append($p_element)	向当前窗体追加指定的 JQuery 对象、元素或控件。
bringToFront()	将当前窗体置为最上层窗体。
clear()	容器的dispose方法
close()	关闭当前窗体，并销毁其中的所有元素，请参见 reusable 字段。该方法会自动调用 hide 方法，并会依次触发 onclosing、onhiding、 onhide 和 onclose 事件。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
findControl(p_alias)	根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。
findControl(p_attrName, p_attrValue)	根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。
findControlByPermissionID(p_permissionID)	根据指定的权限标识查找当前视图中对应的控件。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
hide([p_callback])	将当前窗体隐藏，但不关闭，请参见 reusable 字段。该事件将依次触发 onhiding、onhide 事件。
indicate(p_type, p_message, [p_options])	在当前窗体中显示一个快速提示，通常该提示会在数秒后自动消失。
moveTo(p_left, p_top)	移动控件到指定位置。@param p_left 一个数字，表示 css 样式的 left 属性。 @param p_top 一个数字，表示 css 样式的 top 属性。
previewGridSave()	预览数据表格的保存方法。可重写。
removeControl(p_control, p_deep)	从 controls 集合中移除指定的 Control 对象。从集合中移除控件时，该控件会被从上下文的 DOM 中移除，但仍驻留在内存中，可以重用。
resizeTo(p_width, p_height)	重设控件的大小。@param p_width 控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
setBorder(p_border)	设置控件的边框样式。@param p_border 一个字符串，表示css样式的 border 属性。
setBusy(p_busy, p_indication)	设置 isBusy 字段的值。
setCss(p_css)	设置 css 字段的值。 @param p_css 一个 JSON 对象，表示控件的 CSS 样式。
setCssClass(p_cssClass)	设置 cssClass 字段的值 @param p_cssClass 一个String 对象，样式classname
setDialogResult(p_dialogResult)	设置 dialogResult 字段的值。在调用该方法后，会自动关闭对话框（当 reusable 字段为 true 时，将调用 hide 方法；否则调用 close 方法）。请参见 showDialog 方法。
setEnabled(p_enabled)
setHeight(p_height)	设置 height 字段的值。注：子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
setImportColumns(p_columns)
setLeft(p_left)	设置 left 字段的值。 @param p_left 控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setLoading(p_isLoading)	设置 isLoading 字段的值。
setPadding(p_padding)	设置 {@lilnk padding} 字段的值。
setStatus(p_status, [p_isBusy])	设置窗体的状态 status 字段的值。
setTitle(p_title)	设置 title 字段的值。
setTop(p_top)	设置 top 字段的值。 @param p_top 控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setWidth(p_width)	设置 width 字段的值。@param p_width 控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.
setWindowState(p_windowState)	设置 windowState 字段的值。
show()
showDialog([p_owner], [p_dialogCallback])	将当前窗口以独占对话框的形式打开。该方法会依次触发 onactivate 和 onshown 事件。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。

字段

名称	说明
activated	获取或设置一个 Boolean 值，表示窗体是否处于激活状态。
ajax	获取当前窗口是否使用ajax的方式加载窗口的内容， true：ajax方式加载页面 false：Iframe方式加载页面
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
context	详见 Control.getContext 方法。
contextMenu	获取或设置容器的上下文菜单。@default null
controls	获取容器包含的控件集合。集合中的单个控件也可能是一个容器。请使用 addControl 和 removeControl 方法向集合中添加或移除控件。
cssClass	指定css伪类名称，设置控件显示样式
dialogResult	获取当前窗体作为对话框时返回的值。请使用 setDialogResult 方法设置该字段的值。请参见 showDialog 方法。
displayCloseButton	获取或设置是否显示“关闭”按钮。该字段必须在初始化前设置。
displayControlBox	获取或设置是否显示“最大化”、“关闭”等控制按钮。该字段必须在初始化前设置。
displayHead	获取一个 Boolean 值，表示窗体是否显示标题栏。
displayMaxButton	获取或设置是否显示“最大化”按钮。当 resizable 字段为 false 时，该字段会被自动置为 false。该字段必须在初始化前设置。
displayMinButton	获取或设置是否显示“最小化”按钮。该字段必须在初始化前设置。
displayStatus	获取或设置是否显示状态栏。该字段必须在初始化前设置。
enableBrowserContextMenu	获取或初始化设置是否允许浏览器默认的上下文菜单。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。@default true
eTag	获取控件的标签。
finishCallback	一个回调函数，表示向导完成后执行该方法。
frameBorder	获取或设置窗体的边框样式。该字段必须在初始化前设置。该字段的可选值包括: normal - 正常状态。 borderless 或 none - 没有标题栏、边框和状态栏。
importColumns	一个数组，表示需要导入的列信息。数组中每个元素为 JSON 对象（如{ name:"sex", caption:"性别" }）。
importExcelOptions	一个数组，表示需要导入的 Excel 数据读取设置信息。请参考 DataGrid.importExcelOptions
importExcelUrl	一个字符串，表示处理 Excel 的服务端地址。
isBusy	获取窗体是否正处于忙碌状态，如果该值为 true，则会自动将 isLoading 字段设置为 true，并且窗体会变暗，同时阻止用户对该窗体的所有操作。请使用 setBusy 方法设置该字段的值。
isLoaded	获取一个值，表示当前窗体是否已完成加载。请参考 onload 事件。
isLoading	获取窗体是否正处于正在加载状态，如果该值为 true，则窗体的状态栏中会显示一个正在加载的图标。请使用 setStatus 方法设置该字段的值。
left	获取窗体的左边缘与浏览器左边缘之间的距离，除使用数字（如 100）或字符串（如“100px”、“50%”）等绝对位置外，还可以使用“center”字符串来表示水平方位居中显示。请使用 moveTo 方法设置该字段的值。
movable	获取一个 Boolean 值，表示窗体是否可拖动。
owner	获取一个 Window 对象，表示当前窗体的父窗体对象。通常当一个窗体通过 showDialog 方法作为对话框打开时，会带入一个 p_owner 参数表示该对话框的父窗体。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
params	参见 FileUploader.params 字段。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
previewGridBaseUrl	获取或设置预览表格的 EntityContainer.baseUrl 属性。初始化该控件时，必须设置该属性
resizable	获取是否可以由用户自定义窗体大小。如果为 false，则 displayMaxButton 字段会被设置为 false。该字段必须在初始化前设置。
reusable	覆写父类 Window 中的属性，向导窗体默认可以重用。
status	获取窗体状态栏中的文本。请使用 setStatus 方法设置该字段的值。stuats 字段仅当 displayStatus 字段为 true 时，才能看见状态栏中的内容。
title	获取窗体标题栏中的文本。请使用 setTitle 方法设置该字段的值。
top	获取窗体的上边缘与浏览器上边缘之间的距离，除使用数字（如 100）或字符串（如“100px”、“50%”）等绝对位置外，还可以使用“center”字符串来表示水平方位居中显示。请使用 moveTo 方法设置该字段的值。
view	获取视图。参见 View。
viewController	获取视图控制器。参见 ViewController。
windowState	获取一个字符串，表示当前窗体的状态。请使用 setWindowState 方法设置该字段的值。该字段的可选值包括: normal - 正常状态。窗体的大小取决于 width 和 height 字段的值。 maximize - 最大化状态。窗体自动撑满父容器。
wizard	获取一个 Wizard 对象，表示当前窗体的向导对象。
$body	表示窗体主体部分的 JQuery 对象（不包含标题栏、状态栏的部分）。
$container	获取容器控件中用来包含控件 DOM 元素的占位符。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。
$head	表示标题栏的 JQuery 对象。

事件

名称	说明
onactivate	当窗体被激活后将触发该事件。
onclose	当前窗体被关闭后将触发该事件。通常调用 close 方法后会触发该事件。
onclosing	当窗体被关闭前将触发该事件。通常调用 close 等方法前会触发该事件。
oncontextmenu	在弹出上下之前执行传入执行方法中参数为 {cancel:false,event:e}; cancel如果为true会中断默认逻辑的执行，event为事件参数
onctrladded	当添加控件到容器后，将触发该事件。
onctrlremoved	当从容器移除控件后，将触发该事件。
onhide	当窗体被隐藏或关闭后将触发该事件。通常调用 hide 和 close 等方法后会触发该事件。
onhiding	当窗体被隐藏或关闭前将触发该事件。通常调用 hide 和 close 等方法前会触发该事件。
onload	当窗体加载后将触发该事件。当窗体被实例化并调用 init 进行初始化后，第一次显示在浏览器之前，将触发该事件。该事件在 Window 的全生命周期中仅会触发一次，通常第一次调用 show、showDialog 方法后首先会触发该事件，然后才会触发 onshown 事件。
onresize	当窗体重置大小后将触发该事件。
onshown	当窗体在客户端展现后将触发该事件。通常调用 show 和 showDialog 等方法后会触发该事件。通常第一次调用 show、showDialog 方法后首先会触发该事件，然后才会触发 onshown 事件。
onwizardcancelled	当向导取消，即 Wizard 的 Wizard.oncancelled 事件被触发时，将触发该事件。
onwizardfinished	当向导完成，即 Wizard 的 Wizard.onfinished 事件被触发时，将触发该事件。

构造函数详细信息

ImportExcelWizard() 方法

构建 ImportExcelWizard 类的新实例。

初始化函数详细信息

init() 方法

初始化窗体。

继承自

mx.windows.WizardWindow.init

方法详细信息

activate() 方法

将当前窗体置为激活状态。在该方法中会自动调用 bringToFront 方法，并会触发 onactivate 事件。

继承自

mx.windows.Window.activate

addControl(p_control, p_islinebreak) 方法

将 Control 对象添加到集合 controls 中。@param p_control 一个 Control 对象。 @param p_islinebreak 一个布尔值，表示添加新控件时是否先换行。

参数

p_control
一个 Control 对象。
p_islinebreak
一个布尔值，表示添加新控件时是否先换行。

继承自

mx.containers.Container.addControl

addControls(p_controls) 方法

将一组 Control 对象添加到集合 controls 中。@param p_controls 一个 Control 控件数组。

参数

p_controls
一个 Control 控件数组。

继承自

mx.containers.Container.addControls

append($p_element) 方法

向当前窗体追加指定的 JQuery 对象、元素或控件。

参数

$p_element
需要追加的对象。该对象可以是一个 JQuery 对象、HTML 元素（如 DIV 元素）或所有派生自 Control 类型的控件（如 DataGrid、DataTree 等控件）。

继承自

mx.windows.Window.append

bringToFront() 方法

将当前窗体置为最上层窗体。

继承自

mx.windows.Window.bringToFront

clear() 方法

容器的dispose方法

继承自

mx.containers.Container.clear

close() 方法

关闭当前窗体，并销毁其中的所有元素，请参见 reusable 字段。该方法会自动调用 hide 方法，并会依次触发 onclosing、onhiding、 onhide 和 onclose 事件。

继承自

mx.windows.Window.close

contains($p_target) 方法

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

参数

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

继承自

mx.controls.Control.contains

dispose() 方法

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

继承自

mx.windows.WizardWindow.dispose

findControl(p_alias) 方法

根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。

参数

p_alias
一个字符串，表示控件的别名。

继承自

mx.containers.Container.findControl

findControl(p_attrName, p_attrValue) 方法

参数

p_attrName
一个字符串，表示控件的属性名。
p_attrValue
一个字符串，表示控件的属性值。 {@exclude mx.datacontrols.DynamicForm}

继承自

mx.containers.Container.findControl

findControlByPermissionID(p_permissionID) 方法

根据指定的权限标识查找当前视图中对应的控件。

参数

p_permissionID
一个字符串，表示控件的权限标识。

继承自

mx.containers.Container.findControlByPermissionID

getContext() 方法

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

继承自

mx.controls.Control.getContext

getEl() 方法

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

继承自

mx.controls.Control.getEl

hide([p_callback]) 方法

将当前窗体隐藏，但不关闭，请参见 reusable 字段。该事件将依次触发 onhiding、onhide 事件。

参数

p_callback
可选的。一个 Function 对象，表示窗体隐藏后的回调方法。

继承自

mx.windows.Window.hide

indicate(p_type, p_message, [p_options]) 方法

在当前窗体中显示一个快速提示，通常该提示会在数秒后自动消失。

参数

p_type
一个字符串，表示提示的类型。如“info”、“warn”、“error”等，请参见 SymbolUtilClass.getSymbol 类。
p_message
指定提示的信息。
p_options
可选的。目前暂未使用。

继承自

mx.windows.Window.indicate

moveTo(p_left, p_top) 方法

移动控件到指定位置。@param p_left 一个数字，表示 css 样式的 left 属性。 @param p_top 一个数字，表示 css 样式的 top 属性。

参数

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

继承自

mx.controls.Control.moveTo

previewGridSave() 方法

预览数据表格的保存方法。可重写。

removeControl(p_control, p_deep) 方法

从 controls 集合中移除指定的 Control 对象。从集合中移除控件时，该控件会被从上下文的 DOM 中移除，但仍驻留在内存中，可以重用。

参数

p_control
一个 Control 对象。
p_deep
表示是否从内存中删除指定控件。

继承自

mx.containers.Container.removeControl

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

setBusy(p_busy, p_indication) 方法

设置 isBusy 字段的值。

参数

p_busy
p_indication

继承自

mx.windows.Window.setBusy

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

setDialogResult(p_dialogResult) 方法

设置 dialogResult 字段的值。在调用该方法后，会自动关闭对话框（当 reusable 字段为 true 时，将调用 hide 方法；否则调用 close 方法）。请参见 showDialog 方法。

参数

p_dialogResult

继承自

mx.windows.Window.setDialogResult

setEnabled(p_enabled) 方法

参数

p_enabled

继承自

mx.windows.Window.setEnabled

setHeight(p_height) 方法

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

参数

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

继承自

mx.controls.Control.setHeight

setImportColumns(p_columns) 方法

参数

p_columns

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

setLoading(p_isLoading) 方法

设置 isLoading 字段的值。

参数

p_isLoading

继承自

mx.windows.Window.setLoading

setPadding(p_padding) 方法

设置 {@lilnk padding} 字段的值。

参数

p_padding

继承自

mx.windows.Window.setPadding

setStatus(p_status, [p_isBusy]) 方法

设置窗体的状态 status 字段的值。

参数

p_status
: 窗体的状态状态栏显示的文本
p_isBusy
可选的。isBusy字段饿值，设置窗体是否处于忙碌状态

继承自

mx.windows.Window.setStatus

setTitle(p_title) 方法

设置 title 字段的值。

参数

p_title

继承自

mx.windows.Window.setTitle

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

setWidth(p_width) 方法

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

参数

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

继承自

mx.controls.Control.setWidth

setWindowState(p_windowState) 方法

设置 windowState 字段的值。

参数

p_windowState

继承自

mx.windows.Window.setWindowState

show() 方法

继承自

mx.windows.Window.show

showDialog([p_owner], [p_dialogCallback]) 方法

将当前窗口以独占对话框的形式打开。该方法会依次触发 onactivate 和 onshown 事件。

参数

p_owner
可选的。指定对话框的父窗体。对象类型为mx.windows.Window或者为mx.windows.Window对象的子类
p_dialogCallback
可选的。一个 Function 对象，表示对话框的回调方法。当对话框关闭后，将调用 p_dialogCallback 代表的方法，并将当前窗体作为参数传递，方法的原型为 function(p_dialog)，p_dialog 参数即为当前窗体对象，可通过 p_dialog.dialogResult 字段获取对话框的返回值，该返回值是通过 setDialogResult} 设置的。

继承自

mx.windows.Window.showDialog

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