Class BBCodeDataProcessor

Data processor for BBCode.

This data processor converts BBCode to HTML and uses the HtmlDataProcessor to generate the resulting view tree.

Implements

DataProcessor

Index

Constructors

Methods

addRule addRules registerRawContentMatcher toData toView useFillerType

Constructors

constructor

new BBCodeDataProcessor(document: ViewDocument): BBCodeDataProcessor
Creates a new instance of the BBCode data processor class.
Parameters
- document: ViewDocument
Returns BBCodeDataProcessor
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:49

Methods

addRule

addRule(rule: BBCodeProcessingRule): void
Adds a new rule to the data processing.
Parameters
- rule: BBCodeProcessingRule
  rule to add
Returns void
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:62

addRules

addRules(rules: BBCodeProcessingRule[]): void
Adds new rules to the data processing.
Parameters
- rules: BBCodeProcessingRule[]
  rules to add
Returns void
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:76

registerRawContentMatcher

registerRawContentMatcher(pattern: MatcherPattern): void
Registers a MatcherPattern for view elements whose content should be treated as raw data and not processed during the conversion from generated HTML to view elements.

The raw data can be later accessed by a custom property of a view element called "$rawContent".
Parameters
- pattern: MatcherPattern
  The pattern matching all view elements whose content should be treated as raw data.
Returns void
Implementation of DataProcessor.registerRawContentMatcher
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:134

toData

toData(viewFragment: ViewDocumentFragment): string
Converts the provided DocumentFragment to data format — in this case to a BBCode string.
Parameters
- viewFragment: ViewDocumentFragment
  The viewFragment.
Returns string
BBCode string.
Implementation of DataProcessor.toData
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:108

toView

toView(data: string): ViewDocumentFragment
Converts the provided BBCode string to a data view tree.
Parameters
- data: string
  The BBCode string.
Returns ViewDocumentFragment
The converted view element.
Implementation of DataProcessor.toView
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:86

useFillerType

useFillerType(): void
This method does not have any effect on the data processor result. It exists for compatibility with the DataProcessor interface.

Returns void
Implementation of DataProcessor.useFillerType
- Defined in packages/ckeditor5-bbcode/src/BBCodeDataProcessor.ts:142