@ckeditor/ckeditor5-restricted-editing 36.0.1 → 37.0.0-alpha.1

package/src/restrictededitingmode/converters.js

@@ -2,17 +2,9 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module restricted-editing/restrictededitingmode/converters
- */
-
 import { Matcher } from 'ckeditor5/src/engine';
-
 import { getMarkerAtPosition } from './utils';
-
 const HIGHLIGHT_CLASS = 'restricted-editing-exception_selected';
-
 /**
  * Adds a visual highlight style to a restricted editing exception that the selection is anchored to.
  *
@@ -24,168 +16,127 @@ const HIGHLIGHT_CLASS = 'restricted-editing-exception_selected';
  * * The class is added in the view post-fixer, after other changes in the model tree are converted to the view.
  *
  * This way, adding and removing the highlight does not interfere with conversion.
- *
- * @param {module:core/editor/editor~Editor} editor
  */
-export function setupExceptionHighlighting( editor ) {
-	const view = editor.editing.view;
-	const model = editor.model;
-	const highlightedMarkers = new Set();
-
-	// Adding the class.
-	view.document.registerPostFixer( writer => {
-		const modelSelection = model.document.selection;
-
-		const marker = getMarkerAtPosition( editor, modelSelection.anchor );
-
-		if ( !marker ) {
-			return;
-		}
-
-		for ( const viewElement of editor.editing.mapper.markerNameToElements( marker.name ) ) {
-			writer.addClass( HIGHLIGHT_CLASS, viewElement );
-			highlightedMarkers.add( viewElement );
-		}
-	} );
-
-	// Removing the class.
-	editor.conversion.for( 'editingDowncast' ).add( dispatcher => {
-		// Make sure the highlight is removed on every possible event, before conversion is started.
-		dispatcher.on( 'insert', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'remove', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'attribute', removeHighlight, { priority: 'highest' } );
-		dispatcher.on( 'selection', removeHighlight, { priority: 'highest' } );
-
-		function removeHighlight() {
-			view.change( writer => {
-				for ( const item of highlightedMarkers.values() ) {
-					writer.removeClass( HIGHLIGHT_CLASS, item );
-					highlightedMarkers.delete( item );
-				}
-			} );
-		}
-	} );
+export function setupExceptionHighlighting(editor) {
+    const view = editor.editing.view;
+    const model = editor.model;
+    const highlightedMarkers = new Set();
+    // Adding the class.
+    view.document.registerPostFixer((writer) => {
+        const modelSelection = model.document.selection;
+        const marker = getMarkerAtPosition(editor, modelSelection.anchor);
+        if (!marker) {
+            return false;
+        }
+        for (const viewElement of editor.editing.mapper.markerNameToElements(marker.name)) {
+            writer.addClass(HIGHLIGHT_CLASS, viewElement);
+            highlightedMarkers.add(viewElement);
+        }
+        return false;
+    });
+    // Removing the class.
+    editor.conversion.for('editingDowncast').add(dispatcher => {
+        // Make sure the highlight is removed on every possible event, before conversion is started.
+        dispatcher.on('insert', removeHighlight, { priority: 'highest' });
+        dispatcher.on('remove', removeHighlight, { priority: 'highest' });
+        dispatcher.on('attribute', removeHighlight, { priority: 'highest' });
+        dispatcher.on('selection', removeHighlight, { priority: 'highest' });
+        function removeHighlight() {
+            view.change(writer => {
+                for (const item of highlightedMarkers.values()) {
+                    writer.removeClass(HIGHLIGHT_CLASS, item);
+                    highlightedMarkers.delete(item);
+                }
+            });
+        }
+    });
 }
-
 /**
  * A post-fixer that prevents removing a collapsed marker from the document.
- *
- * @param {module:core/editor/editor~Editor} editor
- * @returns {Function}
  */
-export function resurrectCollapsedMarkerPostFixer( editor ) {
-	// This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
-	return writer => {
-		let changeApplied = false;
-
-		for ( const { name, data } of editor.model.document.differ.getChangedMarkers() ) {
-			if ( name.startsWith( 'restrictedEditingException' ) && data.newRange && data.newRange.root.rootName == '$graveyard' ) {
-				writer.updateMarker( name, {
-					range: writer.createRange( writer.createPositionAt( data.oldRange.start ) )
-				} );
-
-				changeApplied = true;
-			}
-		}
-
-		return changeApplied;
-	};
+export function resurrectCollapsedMarkerPostFixer(editor) {
+    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
+    return writer => {
+        let changeApplied = false;
+        for (const { name, data } of editor.model.document.differ.getChangedMarkers()) {
+            if (name.startsWith('restrictedEditingException') && data.newRange && data.newRange.root.rootName == '$graveyard') {
+                writer.updateMarker(name, {
+                    range: writer.createRange(writer.createPositionAt(data.oldRange.start))
+                });
+                changeApplied = true;
+            }
+        }
+        return changeApplied;
+    };
 }
-
 /**
  * A post-fixer that extends a marker when the user types on its boundaries.
- *
- * @param {module:core/editor/editor~Editor} editor
- * @returns {Function}
  */
-export function extendMarkerOnTypingPostFixer( editor ) {
-	// This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
-	return writer => {
-		let changeApplied = false;
-
-		for ( const change of editor.model.document.differ.getChanges() ) {
-			if ( change.type == 'insert' && change.name == '$text' ) {
-				changeApplied = _tryExtendMarkerStart( editor, change.position, change.length, writer ) || changeApplied;
-				changeApplied = _tryExtendMarkedEnd( editor, change.position, change.length, writer ) || changeApplied;
-			}
-		}
-
-		return changeApplied;
-	};
+export function extendMarkerOnTypingPostFixer(editor) {
+    // This post-fixer shouldn't be necessary after https://github.com/ckeditor/ckeditor5/issues/5778.
+    return writer => {
+        let changeApplied = false;
+        for (const change of editor.model.document.differ.getChanges()) {
+            if (change.type == 'insert' && change.name == '$text') {
+                changeApplied = _tryExtendMarkerStart(editor, change.position, change.length, writer) || changeApplied;
+                changeApplied = _tryExtendMarkedEnd(editor, change.position, change.length, writer) || changeApplied;
+            }
+        }
+        return changeApplied;
+    };
 }
-
 /**
  * A view highlight-to-marker conversion helper.
  *
- * @param {Object} config Conversion configuration.
- * @param {module:engine/view/matcher~MatcherPattern} [config.view] A pattern matching all view elements which should be converted. If not
- * set, the converter will fire for every view element.
- * @param {String|module:engine/model/element~Element|Function} config.model The name of the model element, a model element
- * instance or a function that takes a view element and returns a model element. The model element will be inserted in the model.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
+ * @param config Conversion configuration.
  */
-export function upcastHighlightToMarker( config ) {
-	return dispatcher => dispatcher.on( 'element:span', ( evt, data, conversionApi ) => {
-		const { writer } = conversionApi;
-
-		const matcher = new Matcher( config.view );
-		const matcherResult = matcher.match( data.viewItem );
-
-		// If there is no match, this callback should not do anything.
-		if ( !matcherResult ) {
-			return;
-		}
-
-		const match = matcherResult.match;
-
-		// Force consuming element's name (taken from upcast helpers elementToElement converter).
-		match.name = true;
-
-		const { modelRange: convertedChildrenRange } = conversionApi.convertChildren( data.viewItem, data.modelCursor );
-		conversionApi.consumable.consume( data.viewItem, match );
-
-		const markerName = config.model( data.viewItem );
-		const fakeMarkerStart = writer.createElement( '$marker', { 'data-name': markerName } );
-		const fakeMarkerEnd = writer.createElement( '$marker', { 'data-name': markerName } );
-
-		// Insert in reverse order to use converter content positions directly (without recalculating).
-		writer.insert( fakeMarkerEnd, convertedChildrenRange.end );
-		writer.insert( fakeMarkerStart, convertedChildrenRange.start );
-
-		data.modelRange = writer.createRange(
-			writer.createPositionBefore( fakeMarkerStart ),
-			writer.createPositionAfter( fakeMarkerEnd )
-		);
-		data.modelCursor = data.modelRange.end;
-	} );
+export function upcastHighlightToMarker(config) {
+    return (dispatcher) => dispatcher.on('element:span', (evt, data, conversionApi) => {
+        const { writer } = conversionApi;
+        const matcher = new Matcher(config.view);
+        const matcherResult = matcher.match(data.viewItem);
+        // If there is no match, this callback should not do anything.
+        if (!matcherResult) {
+            return;
+        }
+        const match = matcherResult.match;
+        // Force consuming element's name (taken from upcast helpers elementToElement converter).
+        match.name = true;
+        const { modelRange: convertedChildrenRange } = conversionApi.convertChildren(data.viewItem, data.modelCursor);
+        conversionApi.consumable.consume(data.viewItem, match);
+        const markerName = config.model();
+        const fakeMarkerStart = writer.createElement('$marker', { 'data-name': markerName });
+        const fakeMarkerEnd = writer.createElement('$marker', { 'data-name': markerName });
+        // Insert in reverse order to use converter content positions directly (without recalculating).
+        writer.insert(fakeMarkerEnd, convertedChildrenRange.end);
+        writer.insert(fakeMarkerStart, convertedChildrenRange.start);
+        data.modelRange = writer.createRange(writer.createPositionBefore(fakeMarkerStart), writer.createPositionAfter(fakeMarkerEnd));
+        data.modelCursor = data.modelRange.end;
+    });
 }
-
-// Extend marker if change detected on marker's start position.
-function _tryExtendMarkerStart( editor, position, length, writer ) {
-	const markerAtStart = getMarkerAtPosition( editor, position.getShiftedBy( length ) );
-
-	if ( markerAtStart && markerAtStart.getStart().isEqual( position.getShiftedBy( length ) ) ) {
-		writer.updateMarker( markerAtStart, {
-			range: writer.createRange( markerAtStart.getStart().getShiftedBy( -length ), markerAtStart.getEnd() )
-		} );
-
-		return true;
-	}
-
-	return false;
+/**
+ * Extend marker if change detected on marker's start position.
+ */
+function _tryExtendMarkerStart(editor, position, length, writer) {
+    const markerAtStart = getMarkerAtPosition(editor, position.getShiftedBy(length));
+    if (markerAtStart && markerAtStart.getStart().isEqual(position.getShiftedBy(length))) {
+        writer.updateMarker(markerAtStart, {
+            range: writer.createRange(markerAtStart.getStart().getShiftedBy(-length), markerAtStart.getEnd())
+        });
+        return true;
+    }
+    return false;
 }
-
-// Extend marker if change detected on marker's end position.
-function _tryExtendMarkedEnd( editor, position, length, writer ) {
-	const markerAtEnd = getMarkerAtPosition( editor, position );
-
-	if ( markerAtEnd && markerAtEnd.getEnd().isEqual( position ) ) {
-		writer.updateMarker( markerAtEnd, {
-			range: writer.createRange( markerAtEnd.getStart(), markerAtEnd.getEnd().getShiftedBy( length ) )
-		} );
-
-		return true;
-	}
-
-	return false;
+/**
+ * Extend marker if change detected on marker's end position.
+ */
+function _tryExtendMarkedEnd(editor, position, length, writer) {
+    const markerAtEnd = getMarkerAtPosition(editor, position);
+    if (markerAtEnd && markerAtEnd.getEnd().isEqual(position)) {
+        writer.updateMarker(markerAtEnd, {
+            range: writer.createRange(markerAtEnd.getStart(), markerAtEnd.getEnd().getShiftedBy(length))
+        });
+        return true;
+    }
+    return false;
 }

package/src/restrictededitingmode/utils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import type { DocumentSelection, Marker, Position, Range } from 'ckeditor5/src/engine';
+/**
+ * @module restricted-editing/restrictededitingmode/utils
+ */
+/**
+ * Returns a single "restricted-editing-exception" marker at a given position. Contrary to
+ * {@link module:engine/model/markercollection~MarkerCollection#getMarkersAtPosition}, it returnd a marker also when the postion is
+ * equal to one of the marker's start or end positions.
+ */
+export declare function getMarkerAtPosition(editor: Editor, position: Position): Marker | undefined;
+/**
+ * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
+ */
+export declare function isPositionInRangeBoundaries(range: Range, position: Position): boolean;
+/**
+ * Checks if the selection is fully contained in the marker. Positions on marker boundaries are considered "in".
+ *
+ * ```xml
+ * <marker>[]foo</marker> -> true
+ * <marker>f[oo]</marker> -> true
+ * <marker>f[oo</marker> ba]r -> false
+ * <marker>foo</marker> []bar -> false
+ * ```
+ */
+export declare function isSelectionInMarker(selection: DocumentSelection, marker?: Marker): boolean;

package/src/restrictededitingmode/utils.js

@@ -2,69 +2,49 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module restricted-editing/restrictededitingmode/utils
  */
-
 /**
  * Returns a single "restricted-editing-exception" marker at a given position. Contrary to
  * {@link module:engine/model/markercollection~MarkerCollection#getMarkersAtPosition}, it returnd a marker also when the postion is
  * equal to one of the marker's start or end positions.
- *
- * @param {module:core/editor/editor~Editor} editor
- * @param {module:engine/model/position~Position} position
- * @returns {module:engine/model/markercollection~Marker|undefined} marker
  */
-export function getMarkerAtPosition( editor, position ) {
-	for ( const marker of editor.model.markers ) {
-		const markerRange = marker.getRange();
-
-		if ( isPositionInRangeBoundaries( markerRange, position ) ) {
-			if ( marker.name.startsWith( 'restrictedEditingException:' ) ) {
-				return marker;
-			}
-		}
-	}
+export function getMarkerAtPosition(editor, position) {
+    for (const marker of editor.model.markers) {
+        const markerRange = marker.getRange();
+        if (isPositionInRangeBoundaries(markerRange, position)) {
+            if (marker.name.startsWith('restrictedEditingException:')) {
+                return marker;
+            }
+        }
+    }
 }
-
 /**
  * Checks if the position is fully contained in the range. Positions equal to range start or end are considered "in".
- *
- * @param {module:engine/model/range~Range} range
- * @param {module:engine/model/position~Position} position
- * @returns {Boolean}
  */
-export function isPositionInRangeBoundaries( range, position ) {
-	return (
-		range.containsPosition( position ) ||
-		range.end.isEqual( position ) ||
-		range.start.isEqual( position )
-	);
+export function isPositionInRangeBoundaries(range, position) {
+    return (range.containsPosition(position) ||
+        range.end.isEqual(position) ||
+        range.start.isEqual(position));
 }
-
 /**
  * Checks if the selection is fully contained in the marker. Positions on marker boundaries are considered "in".
  *
- *		<marker>[]foo</marker> -> true
- *		<marker>f[oo]</marker> -> true
- *		<marker>f[oo</marker> ba]r -> false
- *		<marker>foo</marker> []bar -> false
- *
- * @param {module:engine/model/selection~Selection} selection
- * @param {module:engine/model/markercollection~Marker} marker
- * @returns {Boolean}
+ * ```xml
+ * <marker>[]foo</marker> -> true
+ * <marker>f[oo]</marker> -> true
+ * <marker>f[oo</marker> ba]r -> false
+ * <marker>foo</marker> []bar -> false
+ * ```
  */
-export function isSelectionInMarker( selection, marker ) {
-	if ( !marker ) {
-		return false;
-	}
-
-	const markerRange = marker.getRange();
-
-	if ( selection.isCollapsed ) {
-		return isPositionInRangeBoundaries( markerRange, selection.focus );
-	}
-
-	return markerRange.containsRange( selection.getFirstRange(), true );
+export function isSelectionInMarker(selection, marker) {
+    if (!marker) {
+        return false;
+    }
+    const markerRange = marker.getRange();
+    if (selection.isCollapsed) {
+        return isPositionInRangeBoundaries(markerRange, selection.focus);
+    }
+    return markerRange.containsRange(selection.getFirstRange(), true);
 }

package/src/restrictededitingmode.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module restricted-editing/restrictededitingmode
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import '../theme/restrictedediting.css';
+/**
+ * The restricted editing mode plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * The {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing restricted mode editing feature}.
+ * * The {@link module:restricted-editing/restrictededitingmodeui~RestrictedEditingModeUI restricted mode UI feature}.
+ */
+export default class RestrictedEditingMode extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RestrictedEditingMode';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+}

package/src/restrictededitingmode.js

@@ -2,18 +2,13 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module restricted-editing/restrictededitingmode
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import RestrictedEditingModeEditing from './restrictededitingmodeediting';
 import RestrictedEditingModeUI from './restrictededitingmodeui';
-
 import '../theme/restrictedediting.css';
-
 /**
  * The restricted editing mode plugin.
  *
@@ -21,83 +16,18 @@ import '../theme/restrictedediting.css';
  *
  * * The {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing restricted mode editing feature}.
  * * The {@link module:restricted-editing/restrictededitingmodeui~RestrictedEditingModeUI restricted mode UI feature}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class RestrictedEditingMode extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'RestrictedEditingMode';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ RestrictedEditingModeEditing, RestrictedEditingModeUI ];
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'RestrictedEditingMode';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [RestrictedEditingModeEditing, RestrictedEditingModeUI];
+    }
 }
-
-/**
- * The configuration of the restricted editing mode feature. Introduced by the
- * {@link module:restricted-editing/restrictededitingmode~RestrictedEditingMode} feature.
- *
- * Read more in {@link module:restricted-editing/restrictededitingmode~RestrictedEditingModeConfig}.
- *
- * @member {module:restricted-editing/restrictededitingmode~RestrictedEditingModeConfig}
- * module:core/editor/editorconfig~EditorConfig#restrictedEditing
- */
-
-/**
- * The configuration of the restricted editing mode feature.
- * The option is used by the {@link module:restricted-editing/restrictededitingmode~RestrictedEditingMode} feature.
- *
- *		ClassicEditor
- *			.create( {
- * 				restrictedEditing: {
- * 					allowedCommands: [ 'bold', 'link', 'unlink' ],
- * 					allowedAttributes: [ 'bold', 'linkHref' ]
- * 				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- *
- * @interface module:restricted-editing/restrictededitingmode~RestrictedEditingModeConfig
- */
-
-/**
- * The command names allowed in non-restricted areas of the content.
- *
- * Defines which feature commands should be enabled in the restricted editing mode. The commands used for typing and deleting text
- * (`'input'`, `'delete'` and `'deleteForward'`) are allowed by the feature inside non-restricted regions and do not need to be defined.
- *
- * **Note**: The restricted editing mode always allows to use the restricted mode navigation commands as well as `'undo'` and `'redo'`
- * commands.
- *
- * The default value is:
- *
- *		const restrictedEditingConfig = {
- *			allowedCommands: [ 'bold', 'italic', 'link', 'unlink' ]
- *		};
- *
- * To make a command always enabled (also outside non-restricted areas) use
- * {@link module:restricted-editing/restrictededitingmodeediting~RestrictedEditingModeEditing#enableCommand} method.
- *
- * @member {Array.<String>} module:restricted-editing/restrictededitingmode~RestrictedEditingModeConfig#allowedCommands
- */
-
-/**
- * The text attribute names allowed when pasting content ot non-restricted areas.
- *
- * The default value is:
- *
- *		const restrictedEditingConfig = {
- *			allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
- *		};
- *
- * @member {Array.<String>} module:restricted-editing/restrictededitingmode~RestrictedEditingModeConfig#allowedAttributes
- */

package/src/restrictededitingmodeediting.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module restricted-editing/restrictededitingmodeediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The restricted editing mode editing feature.
+ *
+ * * It introduces the exception marker group that renders to `<span>` elements with the `restricted-editing-exception` CSS class.
+ * * It registers the `'goToPreviousRestrictedEditingException'` and `'goToNextRestrictedEditingException'` commands.
+ * * It also enables highlighting exception markers that are selected.
+ */
+export default class RestrictedEditingModeEditing extends Plugin {
+    /**
+     * Command names that are enabled outside the non-restricted regions.
+     */
+    private _alwaysEnabled;
+    /**
+     * Commands allowed in non-restricted areas.
+     *
+     * Commands always enabled combine typing feature commands: `'input'`, `'insertText'`, `'delete'`, and `'deleteForward'` with
+     * commands defined in the feature configuration.
+     */
+    private _allowedInException;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'RestrictedEditingModeEditing';
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Makes the given command always enabled in the restricted editing mode (regardless
+     * of selection location).
+     *
+     * To enable some commands in non-restricted areas of the content use
+     * {@link module:restricted-editing/restrictededitingconfig~RestrictedEditingConfig#allowedCommands} configuration option.
+     *
+     * @param commandName Name of the command to enable.
+     */
+    enableCommand(commandName: string): void;
+    /**
+     * Sets up the restricted mode editing conversion:
+     *
+     * * ucpast & downcast converters,
+     * * marker highlighting in the edting area,
+     * * marker post-fixers.
+     */
+    private _setupConversion;
+    /**
+     * Setups additional editing restrictions beyond command toggling:
+     *
+     * * delete content range trimming
+     * * disabling input command outside exception marker
+     * * restricting clipboard holder to text only
+     * * restricting text attributes in content
+     */
+    private _setupRestrictions;
+    /**
+     * Sets up the command toggling which enables or disables commands based on the user selection.
+     */
+    private _setupCommandsToggling;
+    /**
+     * Checks if commands should be enabled or disabled based on the current selection.
+     */
+    private _checkCommands;
+    /**
+     * Enables commands in non-restricted regions.
+     */
+    private _enableCommands;
+    /**
+     * Disables commands outside non-restricted regions.
+     */
+    private _disableCommands;
+}