Static Readonly pluginAccess to controller interface.
Static requiresGets the data, possibly from cache either if the editor is not ready yet, or if the data are considered equal to the data set before.
options for retrieving data; note, that despite the
rootName any other options are ignored if data are retrieved from cache.
Sets the data to set at editor. If the editor is not ready yet, data will be forwarded as soon as the editor is ready.
data to set
options for setting data
This facade is meant to control data in- and output. It ensures that any data set is returned unchanged, unless editorial actions have been performed meanwhile. Thus, it grants that in a control flow set-data directly followed by get-data the retrieved data are strictly equal to the ones set before.
Motivation: For any control flow set-data and get-data it is perfectly valid that the retrieved data may have subtle differences to the previously set data.
Given HTML as data format, the following representations are equivalent regarding the corresponding representation within a browser (unless CSS rules make a difference here):
Depending on the storage backend, the CKEditor instance is bound to it is possibly important not to signal a change when the change is irrelevant. It may cause overhead such as additional network communication, subsequent publication steps or even may trigger translation processes.