---
title: "Ext.LoadMask"
description: "xtype 为 loadmask 的 Ext JS 原生组件参考。"
---

> Documentation Index
> Fetch the complete documentation index at: https://ag.879818327.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Ext.LoadMask

源码定义：`ext-all-debug.js:41769`。分类：基础组件与提示。

## 创建示例

```javascript
var component = Ext.create("Ext.LoadMask", {
  xtype: "loadmask",
  ariaRole: 'presentation',
  childEls: [,
  cls: Ext.baseCSSPrefix + 'mask-msg',
  isLoadMask: true,
  renderTo: Ext.getBody()
});
```

## 属性

| 属性 | 类型 | 默认值 | 说明 | 配置示例 |
| --- | --- | --- | --- | --- |
| `ariaRole` | `String` | `'presentation'` | 组件在辅助技术中的 ARIA 角色。 | `ariaRole: 'presentation'` |
| `childEls` | `Array` | `[` | 组件创建后需要引用的子 DOM 元素集合。 | `childEls: [` |
| `cls` | `Mixed` | `Ext.baseCSSPrefix + 'mask-msg'` | 附加到组件根元素的 CSS 类名。 | `cls: Ext.baseCSSPrefix + 'mask-msg'` |
| `isLoadMask` | `Boolean` | `true` | 控制是否启用 `isLoadMask` 行为。 | `isLoadMask: true` |
| `maskCls` | `Mixed` | `Ext.baseCSSPrefix + 'mask'` | 配置 `maskCls` 对应的 CSS 类名。 | `maskCls: Ext.baseCSSPrefix + 'mask'` |
| `msg` | `String` | `'Loading...'` | 配置组件的 `msg` 选项。 | `msg: 'Loading...'` |
| `msgCls` | `Mixed` | `Ext.baseCSSPrefix + 'mask-loading'` | 配置 `msgCls` 对应的 CSS 类名。 | `msgCls: Ext.baseCSSPrefix + 'mask-loading'` |
| `renderTpl` | `Array` | `[` | 配置生成组件内容的 `renderTpl` 模板。 | `renderTpl: [` |
| `useMsg` | `Boolean` | `true` | 控制是否启用 `useMsg` 行为。 | `useMsg: true` |
| `useTargetEl` | `Boolean` | `false` | 控制是否启用 `useTargetEl` 行为。 | `useTargetEl: false` |

## 方法

| 方法 | 参数 | 说明 | 调用示例 |
| --- | --- | --- | --- |
| `getRenderTree` | `` | 读取并返回 `renderTree`。 执行时会保留父类默认行为。源码涉及 `callParent()`。 | `component.getRenderTree()` |
| `onRender` | `` | 生成 `on` 的渲染结果。 执行时会保留父类默认行为、更新 `maskEl` 状态。源码涉及 `callParent()`。 | `component.onRender()` |
| `initRenderData` | `` | 调用并直接返回父类的值，不对结果作额外转换。 | `component.initRenderData()` |
| `bindComponent` | `comp` | 绑定 `component`。 执行时会更新 `activeOwner` 状态。源码涉及 `onComponentAdded()`、`mon()`。 | `component.bindComponent(...)` |
| `onComponentAdded` | `owner` | 处理 `componentAdded` 回调。 执行时会更新 `floatParent`、`activeOwner` 状态。源码涉及 `mon()`、`isVisible()`。 | `component.onComponentAdded(...)` |
| `onComponentRemoved` | `owner` | 处理 `componentRemoved` 回调。源码涉及 `mun()`。 | `component.onComponentRemoved(...)` |
| `afterRender` | `` | 生成 `after` 的渲染结果。 执行时会保留父类默认行为。源码涉及 `callParent()`。 | `component.afterRender()` |
| `onOwnerToFront` | `owner, zIndex` | 将 `onOwner` 转换为 `front`。 | `component.onOwnerToFront(...)` |
| `onContainerShow` | `container` | 处理 `containerShow` 回调。源码涉及 `onComponentShow()`。 | `component.onContainerShow(...)` |
| `onContainerHide` | `container` | 处理 `containerHide` 回调。源码涉及 `onComponentHide()`。 | `component.onContainerHide(...)` |
| `onContainerExpand` | `container` | 处理 `containerExpand` 回调。源码涉及 `onComponentShow()`。 | `component.onContainerExpand(...)` |
| `onContainerCollapse` | `container` | 处理 `containerCollapse` 回调。源码涉及 `onComponentHide()`。 | `component.onContainerCollapse(...)` |
| `onComponentHide` | `` | 处理 `componentHide` 回调。 执行时会更新 `showNext` 状态。源码涉及 `isVisible()`、`hide()`。 | `component.onComponentHide()` |
| `onComponentShow` | `` | 处理 `componentShow` 回调。源码涉及 `show()`。 | `component.onComponentShow()` |
| `sizeMask` | `` | 调整尺寸 `mask`。源码涉及 `getOwner()`、`getMaskTarget()`、`isVisible()`、`onOwnerToFront()`。 | `component.sizeMask()` |
| `bindStore` | `store, initial` | 绑定 `store`。源码涉及 `onBeforeLoad()`。 | `component.bindStore(...)` |
| `getStoreListeners` | `store` | 读取并返回 `storeListeners`。 | `component.getStoreListeners(...)` |
| `onDisable` | `` | 处理 `disable` 回调。 执行时会保留父类默认行为。源码涉及 `callParent()`、`onLoad()`。 | `component.onDisable()` |
| `getOwner` | `` | 读取并返回 `owner`。 | `component.getOwner()` |
| `getMaskTarget` | `` | 读取并返回 `maskTarget`。源码涉及 `getOwner()`。 | `component.getMaskTarget()` |
| `onBeforeLoad` | `` | 处理 `beforeLoad` 回调。 执行时会更新 `loading` 状态。源码涉及 `getOwner()`、`maybeShow()`。 | `component.onBeforeLoad()` |
| `maybeShow` | `` | 处理 `maybeShow` 操作。 执行时会更新 `showNext` 状态。源码涉及 `getOwner()`、`show()`。 | `component.maybeShow()` |
| `hide` | `` | 隐藏组件。 执行时会保留父类默认行为、派发 `hide` 事件。源码涉及 `fireEvent()`、`callParent()`。 | `component.hide()` |
| `show` | `` | 显示组件。 执行时会保留父类默认行为、派发 `show` 事件。源码涉及 `fireEvent()`、`callParent()`。 | `component.show()` |
| `afterShow` | `` | 在 `show` 后执行后处理。 执行时会保留父类默认行为、更新 `loading` 状态。源码涉及 `callParent()`、`hasOwnProperty()`、`sizeMask()`。 | `component.afterShow()` |
| `onLoad` | `` | 处理 `load` 回调。 执行时会更新 `loading` 状态。源码涉及 `hide()`。 | `component.onLoad()` |
| `beforeDestroy` | `` | 在 `destroy` 前执行预处理。 执行时会保留父类默认行为、更新 `ownerCt` 状态。源码涉及 `callParent()`。 | `component.beforeDestroy()` |
| `onDestroy` | `` | 处理 `destroy` 回调。 执行时会保留父类默认行为。源码涉及 `callParent()`。 | `component.onDestroy()` |

## 事件

源码中未找到该组件自身注册的事件；可监听继承事件。

Source: https://ag.879818327.xyz/ext/basic/loadmask/index.mdx