AbstractEditorHandler (fullscreen/handlers)
@ckeditor/ckeditor5-fullscreen/src/handlers/abstracteditorhandler
The abstract editor type handler.
This class defines some actions and behaviors that are applied when fullscreen mode is toggled, and which are common
regardless of the editor type. Then, specific classes like ClassicEditorHandler or DecoupledEditorHandler
extend this class with actions specific for these editor types.
Extend this class to provide fullscreen mode handling for unsupported editor types, or if you wish to heavily customize the default behavior.
The only method that is necessary to provide when extending this class is defaultOnEnter. However, make sure to
familiarize yourself with the below full list of actions taken by AbstractEditorHandler to understand what is covered by default,
and what should be provided by you.
When entering the fullscreen mode, the enable method is called. It creates the properly styled container
and handles the editor features that need it, in the following order:
- Saves the scroll positions of all ancestors of the editable element to restore them after leaving the fullscreen mode.
- Executes the
defaultOnEntermethod to move the proper editor UI elements to the fullscreen mode. If you extend the abstract handler, you should override this method to move the elements that are specific to your editor type, like: editable, toolbar, menu bar. UsemoveToFullscreenmethod for this purpose to ensure they are automatically cleaned up after leaving the fullscreen mode. - Adds proper classes to the
<body>and<html>elements to block page scrolling, adjustz-indexetc. - Changes the position of some dialogs to utilize the empty space on the right side of the editable element.
Steps 5-11 are only executed if the corresponding features are used.
- If presence list is used, moves it to the fullscreen mode container.
- If document outline is used, moves it to the fullscreen mode.
- If pagination is used, adjusts it's configuration for the changed view.
- If annotations are used, moves them to the fullscreen mode.
- If revision history is used, overrides the callbacks to show the revision viewer in the fullscreen mode.
- If source editing and document outline are both used, hides the document outline header.
- If custom container is used, hides all other elements in it to ensure they don't create an empty unscrollable space.
Then finally:
- Executes the configured
config.fullscreen.onEnterCallbackfunction. By default, it returns the fullscreen mode container element so it can be further customized.
When leaving the fullscreen mode, the disable method is called. It does the following:
- Execute the configured
config.fullscreen.onLeaveCallbackfunction. - Remove the classes added to the
<body>and<html>elements. - If document outline is used, restore its default container.
- If annotations are used, restore their original state (UI, filters etc).
- If revision history is used, restore the original callbacks.
- If source editing and document outline are both used, restore the document outline header.
- Restore all moved elements to their original place.
- Destroy the fullscreen mode container.
- If the editor has a toolbar, switch its behavior to the one configured in the
shouldGroupWhenFullproperty. - Restore the scroll positions of all ancestors of the editable element.
- If pagination is used, restore its default configuration.
- Restore default dialogs positions.
This class is exported to allow for custom extensions.
Filtering
Properties
-
updateDialogPositionCallback : ( _evt: EventInfo, _name: string, isOpen: boolean ) => voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#updateDialogPositionCallbackStores a bound reference to the _updateDialogPosition method, allowing it to be attached and detached from change event.
-
protected
_closeRevisionViewerCallback : null | ( viewerEditor: any ) => Promise<unknown>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_closeRevisionViewerCallbackA callback that closes the revision viewer, stored to restore the original one after exiting the fullscreen mode.
-
protected
_editor : objectmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_editorAn editor instance. It should be set by the particular editor type handler.
-
protected
_showRevisionViewerCallback : null | ( config: EditorConfig ) => Promise<any>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_showRevisionViewerCallbackA callback that shows the revision viewer, stored to restore the original one after exiting the fullscreen mode.
-
private
_annotationsUIsData : null | Map<string, Record<string, any>>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_annotationsUIsDataData of the annotations UIs that were active before entering the fullscreen mode.
-
private
_document : Documentmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_documentThe document object in which the editor is located.
-
private
_hiddenElements : Map<HTMLElement, string>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_hiddenElementsA map of elements that were hidden when entering the fullscreen mode. It is used to restore their previous visibility when leaving the fullscreen mode and avoid showing elements that were hidden before entering the fullscreen mode.
-
private
_paginationBodyCollection : null | BodyCollectionmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_paginationBodyCollectionThe pagination body collection that is used in the fullscreen mode. If we don't move pagination lines to the fullscreen container, they won't be visible.
-
private
_placeholderMap : Map<string, object>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_placeholderMapMaps placeholder names to placeholder elements and moved elements.
-
private
_savedAncestorsScrollPositions : Map<HTMLElement, object>module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_savedAncestorsScrollPositionsA map matching the ancestors of the editable element with their scroll positions before entering fullscreen mode.
-
private
_wrapper : null | HTMLElementmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_wrapperThe wrapper element that holds the fullscreen mode layout.
Methods
-
constructor( editor )module:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#constructor -
defaultOnEnter() → HTMLElementmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#defaultOnEnterA function that moves the editor UI elements to the fullscreen mode. It should be set by the particular editor type handler.
Returns the fullscreen mode container element so it can be further customized via
fullscreen.onEnterCallbackconfiguration property.Returns
HTMLElement
-
destroy() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#destroy -
disable() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#disableDisables the fullscreen mode by restoring all moved elements and destroying the fullscreen container.
Returns
void
-
enable() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#enableEnables the fullscreen mode. It executes the editor-specific enable handler and then the configured callback.
Returns
void
-
getWrapper() → HTMLElementmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#getWrapper -
moveToFullscreen( elementToMove, placeholderName ) → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#moveToFullscreenMoves the given element to the fullscreen mode container, leaving a placeholder in its place.
Parameters
elementToMove : HTMLElementplaceholderName : string
Returns
void
-
restoreMovedElementLocation( placeholderName ) → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#restoreMovedElementLocationReturns a single moved element to its original place.
Parameters
placeholderName : string
Returns
void
-
private
_destroyContainer() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_destroyContainer -
private
_generateDocumentOutlineContainer() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_generateDocumentOutlineContainerChecks if the DocumentOutlineUI plugin is available and moves its elements to fullscreen mode.
Returns
void
-
private
_generatePresenceListContainer() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_generatePresenceListContainerChecks if the PresenceListUI plugin is available and moves its elements to fullscreen mode.
Returns
void
-
private
_overrideAnnotationsUIs() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_overrideAnnotationsUIsStores the current state of the annotations UIs to restore it when leaving fullscreen mode and switches the UI to the wide sidebar.
Returns
void
-
private
_overrideRevisionHistoryCallbacks() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_overrideRevisionHistoryCallbacksModifies the revision history viewer callbacks to display the viewer in the fullscreen mode.
Returns
void
-
private
_registerFullscreenDialogPositionAdjustments() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_registerFullscreenDialogPositionAdjustmentsAdds an event listener when the dialog opens to adjust its position in fullscreen mode, utilizing the empty space on the right side of the editable element.
Returns
void
-
private
_restoreAnnotationsUIs() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_restoreAnnotationsUIs -
private
_restoreDocumentOutlineDefaultContainer() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_restoreDocumentOutlineDefaultContainerRestores the default value of documentOutlineContainer, which is modified in fullscreen mode.
Returns
void
-
private
_restoreRevisionHistoryCallbacks() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_restoreRevisionHistoryCallbacks -
private
_saveAncestorsScrollPositions( domElement ) → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_saveAncestorsScrollPositionsSaves the scroll positions of all ancestors of the given element.
Parameters
domElement : HTMLElement
Returns
void
-
private
_setNewDialogPosition() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_setNewDialogPositionAdjusts the dialog position to utilize the empty space on the right side of the editable. The new dialog position should be on the right side of the fullscreen view with a 30px margin. Only dialogs with the position set to "editor-top-side" should have their position changed.
Returns
void
-
private
_sourceEditingCallback( _evt, _name, value ) → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_sourceEditingCallbackA callback that hides the document outline header when the source editing mode is enabled. Document outline element itself is hidden by source editing plugin.
Parameters
_evt : EventInfo_name : stringvalue : boolean
Returns
void
-
private
_unregisterFullscreenDialogPositionAdjustments() → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_unregisterFullscreenDialogPositionAdjustmentsRemoves an event listener that adjusts the dialog's position in fullscreen mode.
Returns
void
-
private
_updateDialogPosition( _evt, _name, isOpen ) → voidmodule:fullscreen/handlers/abstracteditorhandler~AbstractEditorHandler#_updateDialogPositionIf dialog is open, adjust its positioning.
Parameters
_evt : EventInfo_name : stringisOpen : boolean
Returns
void
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.