UI Class
src/ui/react/src/components/main.jsx:4
The main editor UI class manages a hierarchy of widgets (toolbars and buttons).
Index
Methods
- _getAriaUpdates
- _getAvailableToolbarsMessage
- _getFocusAction
- _getFocusDismissAction
- _getFocusMoveDirection
- _isValidKey
- _moveFocus
- _onActionPerformed
- _onDismissToolbarFocus
- _onEditorInteraction
- _onEditorKey
- _refresh
- _setUIHidden
- cancelExclusive
- componentDidMount
- componentDidUpdate
- componentWillReceiveProps
- componentWillUnmount
- filterExclusive
- focus
- getDefaultProps
- getInitialState
- handleKey
- mergeExclusiveProps
- moveFocus
- render
- requestExclusive
Properties
Events
Methods
_getAriaUpdates
()
Object
protected
Returns the templates for ARIA messages.
Returns:
ARIA relates messages. Default: { noToolbar: AlloyEditor.Strings.ariaUpdateNoToolbar, oneToolbar: AlloyEditor.Strings.ariaUpdateOneToolbar, manyToolbars: AlloyEditor.Strings.ariaUpdateManyToolbars }
_getAvailableToolbarsMessage
-
domNode
Returns an ARIA message which represents the number of currently available toolbars.
Parameters:
-
domNodeCKEDITOR.dom.elementThe DOM node from which the available toolbars will be retrieved.
Returns:
The ARIA message for the number of available toolbars
_getFocusAction
-
event
Returns the action, if any, that a keyboard event in the current focus manager state should produce.
Parameters:
-
eventObjectThe Keyboard event.
Returns:
An action object with type and direction properties.
_getFocusDismissAction
-
event -
focusMoveDirection
Returns the dismiss action, if any, the focus manager should execute to yield the focus. This will happen in any of these scenarios if a dismiss callback has been specified:
- A dismiss key has been pressed
- In a non-circular focus manager, when:
- The active descendant is the first one and a prev key has been pressed.
- The active descendant is the last one and a next key has been pressed.
Parameters:
-
eventObjectThe Keyboard event.
-
focusMoveDirectionNumberThe focus movement direction (if any).
Returns:
A dismiss action with dismiss and direction properties.
_getFocusMoveDirection
-
event
Returns the direction, if any, in which the focus should be moved. In presence of the shift key modifier, the direction of the movement is inverted.
Parameters:
-
eventObjectThe Keyboard event.
Returns:
The computed direction of the expected focus movement.
_isValidKey
-
keyCode -
keys
Indicates if a given keyCode is valid for the given set of keys.
Parameters:
-
keyCodeNumberAn event keyCode.
-
keysArray | NumberA key set. Can be a number an array of numbers representing the allowed keyCodes.
Returns:
A boolean value indicating if the key is valid.
_moveFocus
-
direction
Moves the focus among descendants in the especified direction.
Parameters:
-
directionNumberThe direction (1 or -1) of the focus movement among descendants.
_onActionPerformed
-
event
Listener to the editor's actionPerformed event. Sets state and redraws the UI of the editor.
Parameters:
-
eventSynteticEventThe provided event
_onDismissToolbarFocus
()
protected
Executed when a dismiss key is pressed over a toolbar to return the focus to the editor.
_onEditorInteraction
-
event
Listener to the editor's userInteraction event. Retrieves the data about the user selection and
provides it via component's state property.
Parameters:
-
eventSynteticEventThe provided event
_onEditorKey
()
protected
Focuses on the active toolbar when the combination ALT+F10 is pressed inside the editor.
_refresh
()
protected
Refreshes the descendants list by executing the CSS selector again and resets the descendants tabIndex.
_setUIHidden
-
target
Checks if the target with which the user interacted is part of editor's UI or it is the editable area. If none of these, sets the state of editor's UI to be hidden.
Parameters:
-
targetDOMElementThe DOM element with which user interacted lastly.
cancelExclusive
-
itemExclusive
Cancels the exclusive state of an widget.
Parameters:
-
itemExclusiveObjectThe widget which exclusive state should be canceled.
componentDidMount
()
Lifecycle. Invoked once, only on the client, immediately after the initial rendering occurs.
componentDidUpdate
()
Lifecycle. Invoked immediately after the component's updates are flushed to the DOM.
Fires ariaUpdate event passing ARIA related messages.
Fires editorUpdate event passing the previous and current properties and state.
componentWillReceiveProps
-
nextProps
Lifecycle. Invoked when a component is receiving new props. This method is not called for the initial render. Calling this.setState() within this function will not trigger an additional render.
Parameters:
-
nextPropsObjectObject containing the current set of properties.
componentWillUnmount
()
Lifecycle. Invoked immediately before a component is unmounted from the DOM.
filterExclusive
-
items
Filters the items and returns only those with exclusive state.
Parameters:
-
itemsArrayThe widgets to be filtered.
Returns:
The item with executive state.
focus
()
Focuses the current active descendant.
Several Widgets can be nested in a component hierarchy by attaching this focus method to the widget DOM node, transferring the DOM focus control to the inner FocusManager.
getDefaultProps
()
Object
Lifecycle. Returns the default values of the properties used in the widget.
Returns:
The default properties.
getInitialState
()
Lifecycle. Invoked once before the component is mounted.
handleKey
-
event
Handles the key events on a DOM node to execute the appropriate navigation when needed.
Parameters:
-
eventObjectThe Keyboard event that was detected on the widget DOM node.
mergeExclusiveProps
-
obj -
itemKey
Merges the provided object with three more properties:
- cancelExclusive - function, which can be used by a widget in order to cancel executive state.
- renderExclusive - boolean flag which indicates if an widget should be rendered exclusively.
- requestExclusive - function, which can be used by a widget in order to obtain exclusive state.
Parameters:
-
objObjectThe properties container which should be merged with the properties, related to exclusive state.
-
itemKeyObjectThey key of an React Widget which should be rendered exclusively.
Returns:
The merged object.
moveFocus
-
direction
Moves the focus among descendants in the especified direction.
Parameters:
-
directionNumberThe direction (1 or -1) of the focus movement among descendants.
render
()
Object
Lifecycle. Renders the UI of the editor. This may include several toolbars and buttons. The editor's UI also takes care of rendering the items in exclusive mode.
Returns:
The content which should be rendered.
requestExclusive
-
itemExclusive
Requests and sets exclusive state of an widget.
Parameters:
-
itemExclusiveObjectThe widget which requests exclusive state.
Properties
ariaUpdates
Object
Localized messages for live aria updates. Should include the following messages:
- noToolbar: Notification for no available toolbar in the editor.
- oneToolbar: Notification for just one available toolbar in the editor.
- manyToolbars: Notification for more than one available toolbar in the editor.
circular
Boolean
Indicates if focus should be set to the first/last descendant when the limits are reached.
descendants
String
String representing the CSS selector used to define the elements that should be handled.
editor
Object
The editor instance where the component is being used.
eventsDelay
Number
The delay (ms), after which key or mouse events will be processed.
focusFirstChild
Boolean
Indicate if should focus the first child of a container
keys
Object
Object representing the keys used to navigate between descendants. The format for the prop is:
{dismiss: value, dismissNext: value, dismissPrev: value, next: value, prev: value} where
value can be both a number or an array of numbers with the allowed keyCodes.
onDismiss
Function
Callback method to be invoked when the focus manager is to be dismissed. This happens in the following scenarios if a dismiss callback has been specified:
- A dismiss key has been pressed
- In a non-circular focus manager, when:
- The active descendant is the first one and a prev key has been pressed.
- The active descendant is the last one and a next key has been pressed.
toolbars
Object
The toolbars configuration for this editor instance
Events
ariaUpdate
Fired when component updates and when it is rendered in the DOM.
The payload consists from a message property containing the ARIA message.
ariaUpdate
Fired when component updates. The payload consists from an object with the following properties:
- prevProps - The previous properties of the component
- prevState - The previous state of the component
- props - The current properties of the component
- state - The current state of the component