ButtonLink Class
The ButtonLink class provides functionality for creating and editing a link in a document. ButtonLink renders in two different modes:
- Normal: Just a button that allows to switch to the edition mode
- Exclusive: The ButtonLinkEdit UI with all the link edition controls.
Index
Methods
Methods
_requestExclusive
()
protected
Requests the link button to be rendered in exclusive mode to allow the creation 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.
getStateClasses
()
String
Returns the list of state classes associated to the current element's state, according to the results of the isActive and isDisabled methods.
Returns:
A string with the state CSS classes.
isActive
()
Boolean
Checks if the current selection is contained within a link.
Returns:
True if the selection is inside a link, false otherwise.
mergeButtonCfgProps
-
props
Merges the properties, passed to the current component with user's configuration
via buttonCfg property.
Parameters:
-
propsObjectThe properties to be merged with the provided configuration for this button. If not passed, the user configuration will be merged with
this.props
Returns:
The merged 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: link
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.