CKEDITOR.style.customHandlers.widget
The class representing a widget style. It is an object like the styles handler for widgets.
Note: This custom style handler does not support all methods of the CKEDITOR.style class. Not supported methods: applyToRange, removeFromRange, applyToObject.
Filtering
Properties
-
alwaysRemoveElement : Booleansince 4.0
Indicates that any matches element of this style will be eventually removed when calling CKEDITOR.editor.removeStyle.
Defaults to
false -
group : Arraysince 4.6.2
An array of groups that this style belongs to. Styles assigned to the same group cannot be combined.
-
includeReadonly : Booleansince 3.5
Indicates that fully selected read-only elements will be included when applying the style (for inline styles only).
Defaults to
false -
widget : StringThe name of widget to which this style can be applied. It is extracted from style definition's
widgetproperty.
Methods
-
constructor( styleDefinition, variablesValues ) → styleCreates a style class instance.
-
apply( editor )Applies the style on the editor's current selection.
Before the style is applied, the method checks if the style is applicable.
Note: The recommended way of applying the style is by using the CKEDITOR.editor.applyStyle method, which is a shorthand for this method.
Parameters
editor : editor | documentThe editor instance in which the style will be applied. A CKEDITOR.dom.document instance is accepted for backward compatibility reasons, although since CKEditor 4.4 this type of argument is deprecated. Read more about the signature change in the CKEDITOR.style documentation.
-
Not implemented.
Overrides: CKEDITOR.style.applyToObject -
Not implemented.
Overrides: CKEDITOR.style.applyToRange -
buildPreview( [ label ] ) → StringBuilds the preview HTML based on the styles definition.
Parameters
[ label ] : StringThe label used in the style preview.
Returns
StringThe HTML of preview.
-
checkActive( elementPath, editor ) → BooleanGets the style state inside the elements path.
Parameters
elementPath : elementPatheditor : editorThe editor instance. Required argument since CKEditor 4.4. The style system will work without it, but it is highly recommended to provide it for integration with all features. Read more about the signature change in the CKEDITOR.style documentation.
Returns
Booleantrueif the element is active in the elements path.
-
checkApplicable( elementPath, editor, [ filter ] ) → BooleanWhether this style can be applied at the specified elements path.
Parameters
elementPath : elementPathThe elements path to check the style against.
editor : editorThe editor instance. Required argument since CKEditor 4.4. The style system will work without it, but it is highly recommended to provide it for integration with all features. Read more about the signature change in the CKEDITOR.style documentation.
[ filter ] : filterIf defined, the style will be checked against this filter as well.
Returns
Booleantrueif this style can be applied at the elements path.
-
checkElement( element ) → BooleanChecks if an element is a wrapper of a widget whose name matches the widget name specified in the style definition.
-
checkElementMatch( element, fullMatch, editor ) → BooleanChecks if the element matches the current style definition.
Parameters
element : elementfullMatch : Booleaneditor : editorThe editor instance. Required argument since CKEditor 4.4. The style system will work without it, but it is highly recommended to provide it for integration with all features. Read more about the signature change in the CKEDITOR.style documentation.
Returns
Boolean
-
checkElementRemovable( element, fullMatch, editor ) → BooleanChecks if an element, or any of its attributes, is removable by the current style definition.
Parameters
element : elementfullMatch : Booleaneditor : editorThe editor instance. Required argument since CKEditor 4.4. The style system will work without it, but it is highly recommended to provide it for integration with all features. Read more about the signature change in the CKEDITOR.style documentation.
Returns
Boolean
-
getClassesArray() → String[]Returns classes defined in the style in form of an array.
Returns
String[]
-
getDefinition() → Objectsince 4.1
Returns the style definition.
Returns
Object
-
remove( editor )Removes the style from the editor's current selection.
Before the style is applied, the method checks if style could be applied.
Note: The recommended way of removing the style is by using the CKEDITOR.editor.removeStyle method, which is a shorthand for this method.
Parameters
editor : editor | documentThe editor instance in which the style will be removed. A CKEDITOR.dom.document instance is accepted for backward compatibility reasons, although since CKEditor 4.4 this type of argument is deprecated. Read more about the signature change in the CKEDITOR.style documentation.
-
Not implemented.
Overrides: CKEDITOR.style.removeFromRange -
removeStylesFromSameGroup( editor ) → Booleansince 4.6.2
Removes all styles that belong to the same group as this style. This method will neither add nor remove the current style. Returns
trueif any style was removed, otherwise returnsfalse. -
toAllowedContentRules( The ) → allowedContentRulesReturns allowed content rules which should be registered for this style. Uses widget's CKEDITOR.plugins.widget.definition.styleableElements to make a rule allowing classes on specified elements or use widget's CKEDITOR.plugins.widget.definition.styleToAllowedContentRules method to transform a style into allowed content rules.