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.');

Constructors

name summary defined by
Schema() Constructs a new Schema instance. tinymce.html.Schema

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 such as TD, VIDEO or IMG. tinymce.html.Schema
getSelfClosingElements() Returns a map with self closing tags such as
  • .
  • tinymce.html.Schema
    getShortEndedElements() Returns a map with short ended elements such as 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. tinymce.html.Schema
    getTextBlockElements() Returns a map with text block elements. Such as: p,h1-h6,div,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 like 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

    Constructors

    Schema

    public constructor function Schema(settings:Object)

    Constructs a new Schema instance.

    Parameters

    Methods

    addCustomElements

    addCustomElements(custom_elements:String)

    Adds custom non HTML elements to the schema.

    Parameters

    addValidChildren

    addValidChildren(valid_children:String)

    Parses a valid children string and adds them to the schema structure. The valid children format is for example: "element[child1|child2]".

    Parameters

    addValidElements

    addValidElements(valid_elements:String)

    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

    getBlockElements

    getBlockElements():Object

    Returns a map with block elements.

    Return value

    getBoolAttrs

    getBoolAttrs():Object

    Returns a map with boolean attributes.

    Return value

    getCustomElements

    getCustomElements():Object

    Returns an map object of all custom elements.

    Return value

    getElementRule

    getElementRule(name:String):Object

    Returns true/false if the specified element is valid or not according to the schema.

    Parameters
    Return value

    getInvalidStyles

    getInvalidStyles()

    Name/value map object with valid styles for each element.

    getMoveCaretBeforeOnEnterElements

    getMoveCaretBeforeOnEnterElements():Object

    Returns a map with elements that the caret should be moved in front of after enter is pressed

    Return value

    getNonEmptyElements

    getNonEmptyElements():Object

    Returns a map with elements that should be treated as contents regardless if it has text content in them or not such as TD, VIDEO or IMG.

    Return value

    getSelfClosingElements

    getSelfClosingElements():Object

    Returns a map with self closing tags such as

  • .

    Return value
    • Object - Name/value lookup map for self closing tags elements.

    getShortEndedElements

    getShortEndedElements():Object

    Returns a map with short ended elements such as BR or IMG.

    Return value
    • Object - Name/value lookup map for short ended elements.

    getSpecialElements

    getSpecialElements():Object

    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.

    Return value
    • Object - Name/value lookup map for special elements.

    getTextBlockElements

    getTextBlockElements():Object

    Returns a map with text block elements. Such as: p,h1-h6,div,address

    Return value
    • Object - Name/value lookup map for block elements.

    getTextInlineElements

    getTextInlineElements():Object

    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

    getValidClasses()

    Name/value map object with valid classes for each element.

    getValidStyles

    getValidStyles()

    Name/value map object with valid styles for each element.

    getWhiteSpaceElements

    getWhiteSpaceElements():Object

    Returns a map with elements where white space is to be preserved like PRE or SCRIPT.

    Return value
    • Object - Name/value lookup map for white space elements.

    isValid

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

    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

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

    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

    setValidElements(valid_elements:String)

    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.

    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.