ButtonStylesListItem Class
The ButtonStylesListItem class provides functionality for previewing a style definition inside a list and applying it to the current editor selection.
Index
Methods
_onClick
()
protected
Applies the item style to the editor selection.
applyStyle
()
Removes or applies the component style to the current selection.
componentWillMount
()
Lifecycle. Invoked once, both on the client and server, immediately before the initial rendering occurs.
componentWillUnmount
()
Lifecycle. Invoked immediately before a component is unmounted from the DOM.
getStyle
()
CKEDITOR.style
Returns instance of CKEDITOR.style which represents the current button style.
Returns:
The current style representation.
isActive
()
Boolean
Checks if style is active in the current selection.
Returns:
True if style is active, false otherwise.
render
()
Object
Lifecycle. Renders the UI of the button.
Returns:
The content which should be rendered.
Properties
key
String
static
The name which will be used as an alias of the button in the configuration.
Default: buttonStylesListItem
style
Object | String
The style the button should handle. Allowed values are:
- Object as described by http://docs.ckeditor.com/#!/api/CKEDITOR.style.
- String pointing to an object inside the editor instance configuration. For example,
style = 'coreStyles_bold'will try to retrieve the style object fromeditor.config.coreStyles_bold. Nested properties such asstyle = 'myplugin.myConfig.myStyle'are also supported and will try to retrieve the style object from the editor configuration as well.