ButtonEmbed Class
The ButtonEmbed class provides functionality for creating and editing an embed link in a document. ButtonEmbed renders in two different modes:
- Normal: Just a button that allows to switch to the edition mode
- Exclusive: The ButtonEmbedEdit UI with all the link edition controls.
Index
Methods
_requestExclusive
()
protected
Requests the link button to be rendered in exclusive mode to allow the embedding of a link.
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.
getDefaultProps
()
Object
Lifecycle. Returns the default values of the properties used in the widget.
Returns:
The default properties.
render
()
Object
Lifecycle. Renders the UI of the button.
Returns:
The content which should be rendered.
Properties
editor
Object
The editor instance where the component is being used.
key
String
static
The name which will be used as an alias of the button in the configuration.
Default: embed
keystroke
Object
The keystroke definition. An object with the following properties:
- fn: The function to be executed
- keys: The keystroke definition, as expected by http://docs.ckeditor.com/#!/api/CKEDITOR.editor-method-setKeystroke
- name: The name for the CKEditor command that will be created. If empty, a random name will be created on the fly
label
String
The label that should be used for accessibility purposes.
tabIndex
Number
The tabIndex of the button in its toolbar current state. A value other than -1 means that the button has focus and is the active element.