CKEDITOR.htmlParser.filter

var filter = new CKEDITOR.htmlParser.filter( {
    text: function( value ) {
        return '@' + value + '@';
    },
    elements: {
        p: function( element ) {
            element.attributes.foo = '1';
        }
    }
} );

var fragment = CKEDITOR.htmlParser.fragment.fromHtml( '<p>Foo<b>bar!</b></p>' ),
    writer = new CKEDITOR.htmlParser.basicWriter();
filter.applyTo( fragment );
fragment.writeHtml( writer );
writer.getHtml(); // '<p foo="1">@Foo@<b>@bar!@</b></p>'

Properties

• readonly

  attributeNameRules : filterRulesGroupCKEDITOR.htmlParser.filter#attributeNameRules

  See source

  Rules for attribute names.

• readonly

  attributesRules : ObjectCKEDITOR.htmlParser.filter#attributesRules

  See source

  Hash of attributeName => rules for attributes.

  Defaults to {}

• readonly

  commentRules : filterRulesGroupCKEDITOR.htmlParser.filter#commentRules

  See source

  Rules for comment nodes.

• readonly

  elementNameRules : filterRulesGroupCKEDITOR.htmlParser.filter#elementNameRules

  See source

  Rules for element names.

• readonly

  elementsRules : ObjectCKEDITOR.htmlParser.filter#elementsRules

  See source

  Hash of elementName => rules for elements.

  Defaults to {}

• readonly

  id : NumberCKEDITOR.htmlParser.filter#id

  See source

  ID of filter instance, which is used to mark elements to which this filter has been already applied.

• readonly

  rootRules : filterRulesGroupCKEDITOR.htmlParser.filter#rootRules

  See source

  Rules for a root node.

• readonly

  textRules : filterRulesGroupCKEDITOR.htmlParser.filter#textRules

  See source

  Rules for text nodes.

Methods

• constructor( [ rules ] ) → filterCKEDITOR.htmlParser.filter#constructor

  See source

  Creates a filter class instance.

  Parameters

  [ rules ] : filterRulesDefinition

  Returns

  filter

• addRules( rules, [ options ] )CKEDITOR.htmlParser.filter#addRules

  See source

  Add rules to this filter.

  Parameters

  rules : filterRulesDefinition

  Object containing filter rules.

  [ options ] : Object | Number

  Object containing rules' options or a priority (for a backward compatibility with CKEditor versions up to 4.2.x).

• applyTo( node )CKEDITOR.htmlParser.filter#applyTo

  See source

  Apply this filter to given node.

  Parameters

  node : node

  The node to be filtered.