全称 mx.weblets.Weblet
命名空间 mx.weblets
类 Weblet
继承层次结构 Weblet
源文件 ~\mx\scripts\weblets\Weblet.js
描述一个 Web 小程序的类。请不要在程序中直接实例化该类。 通常该类会在 weblet.js 中通过 WebletManagerClass.register 方法创建。

构造函数

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

初始化函数

名称 说明
init()

方法

名称 说明
dispose()
err(p_key, p_args) 返回一个字符串，表示错误类的国际化信息。
error(p_message) 在控制台打印 Weblet 的错误日志。日志以 Weblet 的唯一标识加方括号开头。
getContext() 返回该对象的上下文信息。
include(p_path, p_callback) 请参见 {@link MX.include} 方法。
indicate(p_type, p_message, [p_options]) 在指定的容器中显示一个提示。
log(p_message) 在控制台打印 Weblet 的普通日志。日志以 Weblet 的唯一标识加方括号开头（如“[dbm] loaded.”）。
mappath(p_url) 返回一个 Weblet 对应的地址。
msg(p_key, [p_args]) 返回一个字符串，表示国际化信息。
showerror(p_error) 在页面中以统一方式显示错误信息。
warn(p_message) 在控制台打印 Weblet 的警告日志。日志以 Weblet 的唯一标识加方括号开头。

字段

名称 说明
bundleName 获取或设置模块名称。
context 获取该 Weblet 的上下文信息。也可以使用 getContext 方法获取。
hasLoaded 获取一个 Boolean 值，表示 Weblet 是否已加载。
hasStarted 获取一个 Boolean 值，表示 Weblet 是否已启动。
name 获取该 Weblet 的名称。
requires 获取一个集合，包含该对象依赖的所有 Weblet。如果需要跨模块引用 Weblet，可写成“bundle/weblet”的形式。

事件

名称 说明
onload 当该对象加载后将触发该事件。调用 WebletManagerClass.load 方法时会触发该事件。
onstart 当该对象启动后将触发该事件。调用 WebletManagerClass.start 方法时会触发该事件。

构造函数详细信息

Weblet() 方法

构建 Weblet 类的新实例。

初始化函数详细信息

init() 方法

方法详细信息

dispose() 方法

err(p_key, p_args) 方法

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

参数

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

error(p_message) 方法

在控制台打印 Weblet 的错误日志。日志以 Weblet 的唯一标识加方括号开头。

参数

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

getContext() 方法

返回该对象的上下文信息。

include(p_path, p_callback) 方法

请参见 {@link MX.include} 方法。

参数

  • p_path
  • p_callback

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

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

参数

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

log(p_message) 方法

在控制台打印 Weblet 的普通日志。日志以 Weblet 的唯一标识加方括号开头（如“[dbm] loaded.”）。

参数

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

mappath(p_url) 方法

返回一个 Weblet 对应的地址。

参数

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

    该参数的形式包括:

    • ~/ - 以“~/”开头表示获取当前模块的 face 目录地址。
    • ~/../ - 在模块项目中使用本框架时，如果引用其他模块项目的资源必须以该格式或者完整路径。
    • ./ - 以“./”开头表示获取当前 Weblet 的根目录地址。
    • $/ - 以“$/”开头表示获取当前 Weblet 的 resources 目录地址。
    • $locale/ - 以“$locale/”开头表示获取当前 Weblet 的 resources/locales 目录地址。
    • $theme/ - 以“$theme/”开头表示获取当前 Weblet 的 resources/themes 目录地址。
    • 其余 - 其余请参见 {@link MX.mappath} 方法。

msg(p_key, [p_args]) 方法

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

参数

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

showerror(p_error) 方法

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

参数

  • p_error
    一个字符串，表示错误信息；或一个 Error 对象。

warn(p_message) 方法

在控制台打印 Weblet 的警告日志。日志以 Weblet 的唯一标识加方括号开头。

参数

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

字段详细信息

bundleName 字段

获取或设置模块名称。

context 字段

获取该 Weblet 的上下文信息。也可以使用 getContext 方法获取。

hasLoaded 字段

获取一个 Boolean 值，表示 Weblet 是否已加载。

默认值

false

hasStarted 字段

获取一个 Boolean 值，表示 Weblet 是否已启动。

默认值

false

name 字段

获取该 Weblet 的名称。

requires 字段

获取一个集合，包含该对象依赖的所有 Weblet。如果需要跨模块引用 Weblet，可写成“bundle/weblet”的形式。

集合

该字段是一个集合数组字段。 集合中成员的类型为 String。

集合索引

项在集合中的序号（从 0 开始计数）。

事件详细信息

onload 事件

当该对象加载后将触发该事件。调用 WebletManagerClass.load 方法时会触发该事件。

onstart 事件

当该对象启动后将触发该事件。调用 WebletManagerClass.start 方法时会触发该事件。