全称 MX
命名空间
类 MX
继承层次结构 MXObject
源文件 ~\mx\scripts\framework-debug.js
提供一个基础类，为 MX 框架提供运行时环境。该类在运行时只有一个实例 mx。

构造函数

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

初始化函数

名称 说明
init()

方法

名称 说明
err(p_key, p_args) 返回一个字符串，表示错误类的国际化信息。
error(p_message) 在控制台打印 MX 的错误日志。日志以“MX”开头（如“[MX] error.”）。
getScrollBarWidth() 获取滚动条的宽度。
importClass(p_fullClassName, [p_callback]) 加载 JavaScript 脚本。
importMessages(p_moduleName, [p_callback]) 加载国际化资源脚本。
include(p_path, [p_callback]) 加载 JavaScript 脚本或者 CSS 样式库文件。
indicate(p_type, p_message, [p_options]) 在指定的容器中显示一个提示。
loadMXExtModule(p_extWebletName, [p_callback]) 加载框架扩展模块的 Weblet 脚本。
log(p_message) 在控制台打印 MX 的普通日志。日志以“MX”开头（如“[MX] loaded.”）。
mappath(p_url) 返回一个 Weblet 对应的地址。
msg(p_key, [p_args]) 返回一个字符串，表示国际化信息。
setTheme(p_theme, [p_themePath]) 设置 theme 字段的值。
setThemePath(p_themePath) 设置 themePath 字段的值。
showerror(p_error, p_errorPage) 在页面中以统一方式显示错误信息。
warn(p_message) 在控制台打印 MX 的警告日志。日志以“MX”开头（如“[MX] warning.”）。
whenReady(p_callback) 添加一个方法，该方法在所有资源加载完成后被执行。
whenScriptReady(p_callback) 添加一个方法，该方法在所有 JavaScript 脚本加载完成后被执行。
whenStyleReady(p_callback) 添加一个方法，该方法在所有 CSS 样式库加载完成后被执行。

字段

名称 说明
bundleName 获取或设置模块名称。
compressMode 获取一个 Boolean 值，表示当前是否采用压缩模式引入框架。
debugMode 获取一个 Boolean 值，表示当前是否开发。如果为 true 表示当前是开发模式；反之当前为运行时模式。
errorType 获取设置的错误类型，如果为 normal 表示正常提示错误信息，如果为 friendly 表示不显示后台错误信息。
globalUploadMode 获取一个字符串值，表示框架内的上传控件 FileEditor 的默认上传模式。
loadedScripts 获取已经加载完毕的 JavaScript 脚本的集合。
loadedStyles 获取已经加载完毕的 CSS 样式库的集合。
loadingScripts 获取正在加载中的 JavaScript 脚本的集合。
loadingStyles 获取正在加载中的 CSS 样式库的集合。
locale 获取框架的国际化信息。
rootPath 获取当前工程的根路径。
theme 获取或设置框架的主题库名称。 如果需要替换框架提供的主题，请使用 setTheme 方法设置主题。
themePath 获取或设置框架使用的主题库的路径。 如果需要替换框架提供的主题，请设置该字段的值。
_scriptReady_callbacks 受保护的。
_styleReady_callbacks 受保护的。

构造函数详细信息

MX() 方法

构建 MX 类的新实例。

初始化函数详细信息

init() 方法

方法详细信息

err(p_key, p_args) 方法

返回一个字符串，表示错误类的国际化信息。

参数

  • p_key
    一个字符串，表示指定的键。在国际化文件中错误类的国际化信息的键需要以“ERR_”开头，但获取国际化信息时不需要加“ERR_”。
  • p_args
    请参见 msg 方法的“p_args”参数。

error(p_message) 方法

在控制台打印 MX 的错误日志。日志以“MX”开头（如“[MX] error.”）。

参数

  • p_message
    一个字符串，表示需要打印的信息。

getScrollBarWidth() 方法

获取滚动条的宽度。

importClass(p_fullClassName, [p_callback]) 方法

加载 JavaScript 脚本。

参数

  • p_fullClassName
    要加载的类信息，如 mx.windows.Window。
  • p_callback
    可选的。默认值为“null”。加载完成后的回调方法。

importMessages(p_moduleName, [p_callback]) 方法

加载国际化资源脚本。

参数

  • p_moduleName
    要加载的模块名称。
  • p_callback
    可选的。默认值为“null”。加载完成后的回调方法。

include(p_path, [p_callback]) 方法

加载 JavaScript 脚本或者 CSS 样式库文件。

参数

  • p_path
    一个字符串，表示要加载文件的路径。
  • p_callback
    可选的。默认值为“null”。加载完成后的回调方法。

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

在指定的容器中显示一个提示。

参数

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

loadMXExtModule(p_extWebletName, [p_callback]) 方法

加载框架扩展模块的 Weblet 脚本。

参数

  • p_extWebletName
    要加载的扩展模块 Weblet 名称，默认为 "mx"。
  • p_callback
    可选的。默认值为“null”。加载完成后的回调方法。

log(p_message) 方法

在控制台打印 MX 的普通日志。日志以“MX”开头（如“[MX] loaded.”）。

参数

  • p_message
    一个字符串，表示需要打印的信息。

mappath(p_url) 方法

返回一个 Weblet 对应的地址。

参数

  • p_url
    一个字符串，表示特定的地址。

    该参数的形式包括:

    • ~/ - 以“~/”开头表示获取 UAP项目 的根目录地址或网站虚拟路径。
    • ~/../ - 在模块项目中使用本框架时，如果引用其他模块项目的资源必须以该格式或者完整路径。
    • ./ - 以“./”开头表示获取 MX 的根目录地址。
    • $/ - 以“$/”开头表示获取 MX 的 resources 目录地址。
    • $locale/ - 以“$locale/”开头表示获取 MX 的 resources/locales 目录地址。
    • $theme/ - 以“$theme/”开头表示获取 MX 的 resources/themes 目录地址。

msg(p_key, [p_args]) 方法

返回一个字符串，表示国际化信息。

参数

  • p_key
    一个字符串，表示指定的键。
  • p_args
    可选的。默认值为“null”。一个数组或 JSON 对象。当国际化信息为“{0} 已加载。”或“{0} 和 {1} 已加载。”的形式时，参数为数组，分别对应各个占位符中的值；当国际化信息为“{a} 已加载。”或“{a} 和 {b} 已加载。”的形式时，参数为 JSON 对象（如{a: "DBM", b: "DBM2"}）。

setTheme(p_theme, [p_themePath]) 方法

设置 theme 字段的值。

参数

  • p_theme
    一个字符串，表示主题的名称（如“aero”）。
  • p_themePath
    可选的。一个字符串，表示需要使用的主题库的路径（如“~/dbm/resources/themes”）。

setThemePath(p_themePath) 方法

设置 themePath 字段的值。

参数

  • p_themePath
    一个字符串，表示需要使用的主题库的路径（如“~/dbm/resources/themes”）。

showerror(p_error, p_errorPage) 方法

在页面中以统一方式显示错误信息。

参数

  • p_error
    一个字符串，表示错误信息；或一个 Error 对象。
  • p_errorPage
    一个字符串，表示错误页面的地址。

warn(p_message) 方法

在控制台打印 MX 的警告日志。日志以“MX”开头（如“[MX] warning.”）。

参数

  • p_message
    一个字符串，表示需要打印的信息。

whenReady(p_callback) 方法

添加一个方法，该方法在所有资源加载完成后被执行。

参数

  • p_callback
    回调方法。

whenScriptReady(p_callback) 方法

添加一个方法，该方法在所有 JavaScript 脚本加载完成后被执行。

参数

  • p_callback
    回调方法。

whenStyleReady(p_callback) 方法

添加一个方法，该方法在所有 CSS 样式库加载完成后被执行。

参数

  • p_callback
    回调方法。

字段详细信息

bundleName 字段

获取或设置模块名称。

compressMode 字段

获取一个 Boolean 值，表示当前是否采用压缩模式引入框架。

默认值

false

debugMode 字段

获取一个 Boolean 值，表示当前是否开发。如果为 true 表示当前是开发模式；反之当前为运行时模式。

默认值

false

errorType 字段

获取设置的错误类型，如果为 normal 表示正常提示错误信息，如果为 friendly 表示不显示后台错误信息。

默认值

normal

globalUploadMode 字段

获取一个字符串值，表示框架内的上传控件 FileEditor 的默认上传模式。

默认值

null

loadedScripts 字段

获取已经加载完毕的 JavaScript 脚本的集合。

集合

该字段是一个集合数组字段。

集合索引

JavaScript 脚本的 src 属性或者加载完成顺序（从 0 开始计数）。

loadedStyles 字段

获取已经加载完毕的 CSS 样式库的集合。

集合

该字段是一个集合数组字段。

集合索引

CSS 样式库的 href 属性加载完成顺序（从 0 开始计数）。

loadingScripts 字段

获取正在加载中的 JavaScript 脚本的集合。

集合

该字段是一个集合数组字段。

集合索引

JavaScript 脚本的 src 属性或者加载开始顺序（从 0 开始计数）。

loadingStyles 字段

获取正在加载中的 CSS 样式库的集合。

集合

该字段是一个集合数组字段。

集合索引

CSS 样式库的 href 属性或者加载开始顺序（从 0 开始计数）。

locale 字段

获取框架的国际化信息。

默认值

zh_CN

rootPath 字段

获取当前工程的根路径。

theme 字段

获取或设置框架的主题库名称。 如果需要替换框架提供的主题，请使用 setTheme 方法设置主题。

默认值

aero

themePath 字段

获取或设置框架使用的主题库的路径。 如果需要替换框架提供的主题，请设置该字段的值。

默认值

~/mx/resources/themes

_scriptReady_callbacks 字段

受保护的。

_styleReady_callbacks 字段

受保护的。