tinymce.html.Schema
Schema validator class.
Examples
if (tinymce.activeEditor.schema.isValidChild('p', 'span'))
alert('span is valid child of p.');
if (tinymce.activeEditor.schema.getElementRule('p'))
alert('P is a valid element.');Methods
| name | summary | defined by |
|---|---|---|
| addCustomElements() | Adds custom non-HTML elements to the schema. | tinymce.html.Schema |
| addValidChildren() | Parses a valid children string and adds them to the schema structure. The valid children format is for example element[child1|child2]. | tinymce.html.Schema |
| addValidElements() | Parses a valid elements string and adds it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema. | tinymce.html.Schema |
| getBlockElements() | Returns a map with block elements. | tinymce.html.Schema |
| getBoolAttrs() | Returns a map with boolean attributes. | tinymce.html.Schema |
| getCustomElements() | Returns an map object of all custom elements. | tinymce.html.Schema |
| getElementRule() | Returns true/false if the specified element is valid or not according to the schema. | tinymce.html.Schema |
| getInvalidStyles() | Name/value map object with valid styles for each element. | tinymce.html.Schema |
| getMoveCaretBeforeOnEnterElements() | Returns a map with elements that the caret should be moved in front of after enter is pressed. | tinymce.html.Schema |
| getNonEmptyElements() | Returns a map with elements that should be treated as contents regardless if it has text content in them or not. For example: <td>, <video> or <img>. | tinymce.html.Schema |
| getSelfClosingElements() | Returns a map with self closing tags. For example: <li>. | tinymce.html.Schema |
| getShortEndedElements() | Returns a map with short ended elements. For example: <br> or <img>. | tinymce.html.Schema |
| getSpecialElements() | Returns a map with special elements. These are elements that needs to be parsed in a special way such as script, style, textarea etc. The map object values are regexps used to find the end of the element. Deprecated in TinyMCE 5.10 and has been marked for removal in TinyMCE 6.0. | tinymce.html.Schema |
| getTextBlockElements() | Returns a map with text block elements. For example: <p>, <h1> to <h6>, <div> or <address>. | tinymce.html.Schema |
| getTextInlineElements() | Returns a map of inline text format nodes. For example: <strong>, <span> or <ins>. | tinymce.html.Schema |
| getValidClasses() | Name/value map object with valid classes for each element. | tinymce.html.Schema |
| getValidStyles() | Name/value map object with valid styles for each element. | tinymce.html.Schema |
| getWhiteSpaceElements() | Returns a map with elements where white space is to be preserved. For example: <pre> or <script>. | tinymce.html.Schema |
| isValid() | Returns true/false if the specified element name and optional attribute is valid according to the schema. | tinymce.html.Schema |
| isValidChild() | Returns true/false if the specified element and it's child is valid or not according to the schema. | tinymce.html.Schema |
| setValidElements() | Parses a valid elements string and sets it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema. | tinymce.html.Schema |
Methods
addCustomElements
Adds custom non-HTML elements to the schema.
Parameters
- custom_elements (String) - Comma separated list of custom elements to add.
addValidChildren
Parses a valid children string and adds them to the schema structure. The valid children format is for example element[child1|child2].
Parameters
- valid_children (String) - Valid children elements string to parse
addValidElements
Parses a valid elements string and adds it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.
Parameters
- valid_elements (String) - String in the valid elements format to be parsed.
getBlockElements
Returns a map with block elements.
Return value
- Object - Name/value lookup map for block elements.
getBoolAttrs
Returns a map with boolean attributes.
Return value
- Object - Name/value lookup map for boolean attributes.
getCustomElements
Returns an map object of all custom elements.
Return value
- Object - Name/value map object of all custom elements.
getElementRule
Returns true/false if the specified element is valid or not according to the schema.
Parameters
- name (String) - Element name to check for.
Return value
- Object - Element object or undefined if the element isn't valid.
getInvalidStyles
Name/value map object with valid styles for each element.
getMoveCaretBeforeOnEnterElements
Returns a map with elements that the caret should be moved in front of after enter is pressed.
Return value
- Object - Name/value lookup map for elements to place the caret in front of.
getNonEmptyElements
Returns a map with elements that should be treated as contents regardless if it has text content in them or not. For example: <td>, <video> or <img>.
Return value
- Object - Name/value lookup map for non empty elements.
getSelfClosingElements
Returns a map with self closing tags. For example: <li>.
Return value
- Object - Name/value lookup map for self closing tags elements.
getShortEndedElements
Returns a map with short ended elements. For example: <br> or <img>.
Return value
- Object - Name/value lookup map for short ended elements.
getSpecialElements
Returns a map with special elements. These are elements that needs to be parsed in a special way such as script, style, textarea etc. The map object values are regexps used to find the end of the element.
Deprecated in TinyMCE 5.10 and has been marked for removal in TinyMCE 6.0.
Return value
- Object - Name/value lookup map for special elements.
getTextBlockElements
Returns a map with text block elements. For example: <p>, <h1> to <h6>, <div> or <address>.
Return value
- Object - Name/value lookup map for block elements.
getTextInlineElements
Returns a map of inline text format nodes. For example: <strong>, <span> or <ins>.
Return value
- Object - Name/value lookup map for text format elements.
getValidClasses
Name/value map object with valid classes for each element.
getValidStyles
Name/value map object with valid styles for each element.
getWhiteSpaceElements
Returns a map with elements where white space is to be preserved. For example: <pre> or <script>.
Return value
- Object - Name/value lookup map for white space elements.
isValid
Returns true/false if the specified element name and optional attribute is valid according to the schema.
Parameters
- name (String) - Name of element to check.
- attr (String) - Optional attribute name to check for.
Return value
- Boolean - True/false if the element and attribute is valid.
isValidChild
Returns true/false if the specified element and it's child is valid or not according to the schema.
Parameters
- name (String) - Element name to check for.
- child (String) - Element child to verify.
Return value
- Boolean - True/false if the element is a valid child of the specified parent.
setValidElements
Parses a valid elements string and sets it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.
Parameters
- valid_elements (String) - String in the valid elements format to be parsed.
Can't find what you're looking for? Let us know.
Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.