---
title: "Ext.Editor"
description: "xtype 为 editor 的 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.Editor

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

## 创建示例

```javascript
var component = Ext.create("Ext.Editor", {
  xtype: "editor",
  alignment: 'c-c?',
  allowBlur: true,
  baseCls: Ext.baseCSSPrefix + 'editor',
  cancelOnEsc: true,
  renderTo: Ext.getBody()
});
```

## 属性

| 属性 | 类型 | 默认值 | 说明 | 配置示例 |
| --- | --- | --- | --- | --- |
| `alignment` | `String` | `'c-c?'` | 配置组件的 `alignment` 选项。 | `alignment: 'c-c?'` |
| `allowBlur` | `Boolean` | `true` | 控制是否启用 `allowBlur` 行为。 | `allowBlur: true` |
| `baseCls` | `Mixed` | `Ext.baseCSSPrefix + 'editor'` | 配置 `baseCls` 对应的 CSS 类名。 | `baseCls: Ext.baseCSSPrefix + 'editor'` |
| `cancelOnEsc` | `Boolean` | `true` | 控制是否启用 `cancelOnEsc` 行为。 | `cancelOnEsc: true` |
| `completeOnEnter` | `Boolean` | `true` | 控制是否启用 `completeOnEnter` 行为。 | `completeOnEnter: true` |
| `constrain` | `Boolean` | `false` | 控制是否启用 `constrain` 行为。 | `constrain: false` |
| `constrainToBottom` | `Boolean` | `true` | 控制是否启用 `constrainToBottom` 行为。 | `constrainToBottom: true` |
| `focusOnToFront` | `Boolean` | `false` | 控制是否启用 `focusOnToFront` 行为。 | `focusOnToFront: false` |
| `hidden` | `Boolean` | `true` | 控制组件初始是否隐藏。 | `hidden: true` |
| `layout` | `String` | `'editor'` | 容器对子组件进行排布的布局配置。 | `layout: 'editor'` |
| `revertInvalid` | `Boolean` | `true` | 控制是否启用 `revertInvalid` 行为。 | `revertInvalid: true` |
| `shadow` | `String` | `'frame'` | 配置组件的 `shadow` 选项。 | `shadow: 'frame'` |
| `swallowKeys` | `Boolean` | `true` | 控制是否启用 `swallowKeys` 行为。 | `swallowKeys: true` |
| `updateEl` | `Boolean` | `false` | 控制是否启用 `updateEl` 行为。 | `updateEl: false` |
| `value` | `String` | `''` | 组件的当前值。 | `value: ''` |

## 方法

| 方法 | 参数 | 说明 | 调用示例 |
| --- | --- | --- | --- |
| `initComponent` | `` | 初始化组件及其子项。 执行时会保留父类默认行为、更新 `field`、`floating` 状态。源码涉及 `mon()`、`callParent()`、`addEvents()`。 | `component.initComponent()` |
| `onFieldAutosize` | `` | 处理 `fieldAutosize` 回调。 执行时会刷新界面或布局。源码涉及 `updateLayout()`。 | `component.onFieldAutosize()` |
| `afterRender` | `ct, position` | 生成 `after` 的渲染结果。 执行时会保留父类默认行为。源码涉及 `callParent()`。 | `component.afterRender(...)` |
| `onSpecialKey` | `field, event` | 处理 `specialKey` 回调。 执行时会派发 `specialkey` 事件。源码涉及 `completeEdit()`、`cancelEdit()`、`fireEvent()`。 | `component.onSpecialKey(...)` |
| `startEdit` | `el, value` | 开始 `edit`。 执行时会派发 `beforestartedit` 事件、更新 `boundEl`、`renderTo` 状态。源码涉及 `completeEdit()`、`fireEvent()`、`show()`、`realign()`。 | `component.startEdit(...)` |
| `realign` | `autoSize` | 重新对齐当前组件。 执行时会刷新界面或布局。源码涉及 `updateLayout()`、`alignTo()`。 | `component.realign(...)` |
| `completeEdit` | `remainVisible` | 完成 `edit`。 执行时会派发 `beforecomplete`、`complete` 事件。源码涉及 `getValue()`、`cancelEdit()`、`hideEdit()`、`fireEvent()`。 | `component.completeEdit(...)` |
| `onShow` | `` | 处理 `show` 回调。 执行时会保留父类默认行为、派发 `startedit` 事件。源码涉及 `callParent()`、`fireEvent()`。 | `component.onShow()` |
| `cancelEdit` | `remainVisible` | 取消 `edit`。 执行时会派发 `canceledit` 事件、更新组件值、更新 `editedValue` 状态。源码涉及 `getValue()`、`setValue()`、`hideEdit()`、`fireEvent()`。 | `component.cancelEdit(...)` |
| `hideEdit` | `remainVisible` | 隐藏 `edit`。 执行时会更新 `editing` 状态。源码涉及 `hide()`。 | `component.hideEdit(...)` |
| `onFieldBlur` | `field, e` | 处理 `fieldBlur` 回调。源码涉及 `completeEdit()`。 | `component.onFieldBlur(...)` |
| `onHide` | `` | 处理 `hide` 回调。 执行时会保留父类默认行为。源码涉及 `completeEdit()`、`callParent()`。 | `component.onHide()` |
| `setValue` | `value` | 设置 `value`。 | `component.setValue(...)` |
| `getValue` | `` | 读取并返回 `value`。 | `component.getValue()` |
| `beforeDestroy` | `` | 在 `destroy` 前执行预处理。 执行时会保留父类默认行为。源码涉及 `callParent()`。 | `component.beforeDestroy()` |

## 事件

| 事件 | 说明 | 监听示例 |
| --- | --- | --- |
| `beforecomplete` | 编辑提交前触发；监听器返回 `false` 可阻止提交。 源码在 `completeEdit()` 中通过 `fireEvent()` 触发。 | `listeners: { beforecomplete: function () {} }` |
| `beforestartedit` | 单元格或行开始编辑前触发；监听器返回 `false` 可取消编辑。 源码在 `startEdit()` 中通过 `fireEvent()` 触发。 | `listeners: { beforestartedit: function () {} }` |
| `canceledit` | 编辑被取消后触发。 源码在 `cancelEdit()` 中通过 `fireEvent()` 触发。 | `listeners: { canceledit: function () {} }` |
| `complete` | 当前操作完成后触发。 源码在 `completeEdit()` 中通过 `fireEvent()` 触发。 | `listeners: { complete: function () {} }` |
| `specialkey` | 组件获得特殊按键输入时触发。 源码在 `onSpecialKey()` 中通过 `fireEvent()` 触发。 | `listeners: { specialkey: function () {} }` |
| `startedit` | 单元格或行开始编辑后触发。 源码在 `onShow()` 中通过 `fireEvent()` 触发。 | `listeners: { startedit: function () {} }` |

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