tinymce.html.Schema

Schema 验证器类。

示例

if (tinymce.activeEditor.schema.isValidChild('p', 'span')) {
  alert('span 是 p 的有效子元素。');
}

if (tinymce.activeEditor.schema.getElementRule('p')) {
  alert('P 是有效的元素。');
}

概述

方法

方法

addCustomElements()

addCustomElements(custom_elements: String | Object)

向 schema 添加自定义的非 HTML 元素。有关添加自定义元素的更多信息，请参阅：custom_elements

参数

• custom_elements (String | Object) - 要添加的自定义元素的逗号分隔列表或记录。

addValidChildren()

addValidChildren(valid_children: String)

解析有效的子元素字符串并将其添加到 schema 结构中。有效子元素的格式示例为 element[child1|child2]。

参数

• valid_children (String) - 要解析的有效子元素字符串

addValidElements()

addValidElements(valid_elements: String)

解析有效的元素字符串并将其添加到 schema 中。有效元素的格式示例为 element[attr=default|otherattr]。现有规则将被替换为指定的规则，因此此操作会扩展 schema。

参数

• valid_elements (String) - 要解析的有效元素格式字符串。

getBlockElements()

getBlockElements(): Object

返回包含块级元素的映射。

返回值

• Object - 块级元素的键/值查找映射。

getBoolAttrs()

getBoolAttrs(): Object

返回包含布尔属性的映射。

返回值

• Object - 布尔属性的键/值查找映射。

getComponentUrls()

getComponentUrls(): Object

返回所有具有组件 URL 的自定义元素的一个对象。

返回值

• Object - 键为组件，值为该组件 URL 的对象。

getCustomElements()

getCustomElements(): Object

返回所有自定义元素的映射对象。

返回值

• Object - 所有自定义元素的键/值映射对象。

getElementRule()

getElementRule(name: String): Object

根据 schema 返回指定元素是否有效的布尔值（true/false）。

参数

• name (String) - 要检查的元素名称。

返回值

• Object - 元素对象，如果元素无效则返回 undefined。

getInvalidStyles()

getInvalidStyles()

包含每个元素有效样式的键/值映射对象。

getMoveCaretBeforeOnEnterElements()

getMoveCaretBeforeOnEnterElements(): Object

返回包含按下 Enter 键后光标应移动到其前面的元素的映射。

返回值

• Object - 要将光标置于其前面的元素的键/值查找映射。

getNonEmptyElements()

getNonEmptyElements(): Object

返回包含无论是否包含文本内容都应被视为内容的元素的映射。例如：<td>、<video> 或 <img>。

返回值

• Object - 非空元素的键/值查找映射。

getSelfClosingElements()

getSelfClosingElements(): Object

返回包含自闭合标签的映射。例如：<li>。

返回值

• Object - 自闭合标签元素的键/值查找映射。

getSpecialElements()

getSpecialElements(): Object

返回包含特殊元素的映射。这些元素需要以特殊方式解析，例如 script、style、textarea 等。映射对象的值是用于查找元素末尾的正则表达式。

返回值

• Object - 特殊元素的键/值查找映射。

getTextBlockElements()

getTextBlockElements(): Object

返回包含文本块元素的映射。例如：<p>、<h1> 到 <h6>、<div> 或 <address>。

返回值

• Object - 块级元素的键/值查找映射。

getTextInlineElements()

getTextInlineElements(): Object

返回包含内联文本格式节点的映射。例如：<strong>、<span> 或 <ins>。

返回值

• Object - 文本格式元素的键/值查找映射。

getTransparentElements()

getTransparentElements(): Object

返回包含应被视为透明元素的映射。

返回值

• Object - 特殊元素的键/值查找映射。

getValidClasses()

getValidClasses()

包含每个元素有效类的键/值映射对象。

getValidStyles()

getValidStyles()

包含每个元素有效样式的键/值映射对象。

getVoidElements()

getVoidElements(): Object

返回包含空元素的映射。例如：<br> 或 <img>。

返回值

• Object - 空元素的键/值查找映射。

getWhitespaceElements()

getWhitespaceElements(): Object

返回一个包含需要保留空白符的元素的映射。例如：<pre> 或 <script>。

返回值

• Object - 空白符元素的名称/值查找映射。

isValid()

isValid(name: String, attr: String): Boolean

根据模式返回指定元素名称和可选属性是否有效的 true/false。

参数

• name (String) - 要检查的元素名称。

• attr (String) - 可选的要检查的属性名称。

返回值

• Boolean - 如果元素和属性有效则为 true/false。

isValidChild()

isValidChild(name: String, child: String): Boolean

根据模式返回指定元素及其子元素是否有效的 true/false。

参数

• name (String) - 要检查的元素名称。

• child (String) - 要验证的元素子元素。

返回值

• Boolean - 如果元素是指定父元素的有效子元素则为 true/false。

setValidElements()

setValidElements(valid_elements: String)

解析有效的元素字符串并将其设置为模式。有效元素的格式示例为 element[attr=default|otherattr]。现有规则将被指定的规则替换，因此这将扩展模式。

参数

• valid_elements (String) - 要解析的有效元素格式的字符串。