@univerjs/sheets-ui 0.2.2 → 0.2.4-alpha.0

package/lib/types/services/selection/base-selection-render.service.d.ts

@@ -0,0 +1,173 @@
+import { IInterceptor, Injector, IRange, IRangeWithCoord, ISelectionCell, ISelectionCellWithMergeInfo, ISelectionWithCoord, Nullable, ThemeService, Disposable, InterceptorManager, RANGE_TYPE } from '@univerjs/core';
+import { IMouseEvent, IPointerEvent, IRenderManagerService, IRenderModule, Scene, SpreadsheetSkeleton, Viewport, ScrollTimer, ScrollTimerType } from '@univerjs/engine-render';
+import { ISelectionStyle, ISelectionWithCoordAndStyle, ISelectionWithStyle } from '@univerjs/sheets';
+import { IShortcutService } from '@univerjs/ui';
+import { Observable, Subscription, BehaviorSubject, Subject } from 'rxjs';
+import { SelectionControl } from './selection-shape';
+
+export interface IControlFillConfig {
+    oldRange: IRange;
+    newRange: IRange;
+}
+export interface ISheetSelectionRenderService {
+    readonly selectionMoveEnd$: Observable<ISelectionWithCoordAndStyle[]>;
+    readonly controlFillConfig$: Observable<IControlFillConfig | null>;
+    readonly selectionMoving$: Observable<ISelectionWithCoordAndStyle[]>;
+    readonly selectionMoveStart$: Observable<ISelectionWithCoordAndStyle[]>;
+    interceptor: InterceptorManager<{
+        RANGE_MOVE_PERMISSION_CHECK: IInterceptor<boolean, null>;
+        RANGE_FILL_PERMISSION_CHECK: IInterceptor<boolean, {
+            x: number;
+            y: number;
+            skeleton: SpreadsheetSkeleton;
+            scene: Scene;
+        }>;
+    }>;
+    /** @deprecated This should not be provided by the selection render service. */
+    getViewPort(): Viewport;
+    getSkeleton(): SpreadsheetSkeleton;
+    getSelectionControls(): SelectionControl[];
+    /** @deprecated Use the function `attachSelectionWithCoord` instead. */
+    attachSelectionWithCoord(selectionWithStyle: ISelectionWithStyle): ISelectionWithCoordAndStyle;
+    /** @deprecated Use the function `attachPrimaryWithCoord` instead`. */
+    attachPrimaryWithCoord(primary: Nullable<Partial<ISelectionCell>>): Nullable<ISelectionCellWithMergeInfo>;
+    getSelectionCellByPosition(x: number, y: number): Nullable<ISelectionCellWithMergeInfo>;
+    setSingleSelectionEnabled(enabled: boolean): void;
+}
+export declare const ISheetSelectionRenderService: import('@univerjs/core').IdentifierDecorator<ISheetSelectionRenderService>;
+/**
+ * The basic implementation of selection rendering logics. It is designed to be reused for different purposes.
+ */
+export declare class BaseSelectionRenderService extends Disposable implements ISheetSelectionRenderService, IRenderModule {
+    protected readonly _injector: Injector;
+    protected readonly _themeService: ThemeService;
+    protected readonly _shortcutService: IShortcutService;
+    protected readonly _renderManagerService: IRenderManagerService;
+    private _downObserver;
+    protected _scenePointerMoveSub: Nullable<Subscription>;
+    protected _scenePointerUpSub: Nullable<Subscription>;
+    private _controlFillConfig$;
+    readonly controlFillConfig$: Observable<IControlFillConfig | null>;
+    protected _selectionControls: SelectionControl[];
+    protected _startRangeWhenPointerDown: IRangeWithCoord;
+    /**
+     * the posX of viewport when the pointer down
+     */
+    protected _startViewportPosX: number;
+    /**
+     * the posY of viewport when the pointer down
+     */
+    protected _startViewportPosY: number;
+    protected _scrollTimer: ScrollTimer;
+    private _cancelDownSubscription;
+    private _cancelUpSubscription;
+    protected _skeleton: SpreadsheetSkeleton;
+    protected _scene: Scene;
+    protected _isHeaderHighlight: boolean;
+    protected _shouldDetectMergedCells: boolean;
+    protected _selectionStyle: ISelectionStyle;
+    protected _remainLastEnabled: boolean;
+    protected _skipLastEnabled: boolean;
+    protected _singleSelectionEnabled: boolean;
+    protected readonly _selectionMoveEnd$: BehaviorSubject<ISelectionWithCoordAndStyle[]>;
+    readonly selectionMoveEnd$: Observable<ISelectionWithCoordAndStyle[]>;
+    protected readonly _selectionMoving$: Subject<ISelectionWithCoordAndStyle[]>;
+    readonly selectionMoving$: Observable<ISelectionWithCoordAndStyle[]>;
+    protected readonly _selectionMoveStart$: Subject<ISelectionWithCoordAndStyle[]>;
+    readonly selectionMoveStart$: Observable<ISelectionWithCoordAndStyle[]>;
+    protected _activeViewport: Nullable<Viewport>;
+    readonly interceptor: InterceptorManager<{
+        RANGE_MOVE_PERMISSION_CHECK: IInterceptor<boolean, null>;
+        RANGE_FILL_PERMISSION_CHECK: IInterceptor<boolean, {
+            x: number;
+            y: number;
+            skeleton: SpreadsheetSkeleton;
+            scene: Scene;
+        }>;
+    }>;
+    constructor(_injector: Injector, _themeService: ThemeService, _shortcutService: IShortcutService, _renderManagerService: IRenderManagerService);
+    protected _setStyle(style: ISelectionStyle): void;
+    protected _resetStyle(): void;
+    /** @deprecated This should not be provided by the selection render service. */
+    getViewPort(): Viewport;
+    setSingleSelectionEnabled(enabled?: boolean): void;
+    /**
+     * add a selection
+     *
+     * in PC:init & pointerup would call this function.
+     *
+     * init
+     * selectionController@_initSkeletonChangeListener --> selectionManagerService.add --> selectionManagerService._selectionMoveEnd$ --> this.addControlToCurrentByRangeData
+     *
+     * selectionMoveEnd$ --> this.addSelectionControlBySelectionData
+     *
+     *
+     *
+     * pointer
+     * engine@_pointerDownEvent --> spreadsheet?.onPointerDownObserve --> eventTrigger --> scene@disableEvent() --> then scene.input-manager currentObject is always scene until scene@enableEvent.
+     * engine@_pointerUpEvent --> scene.input-manager@_onPointerUp --> this._selectionMoveEnd$ --> _selectionManagerService.selectionMoveEnd$ --> this.addControlToCurrentByRangeData
+     *
+     * but in mobile, we do not call disableEvent() in eventTrigger,
+     * so pointerup --> scene.input-manager currentObject is spreadsheet --> this.eventTrigger
+     *
+     *
+     * columnHeader pointerup$ --> selectionMoveEnd$ --> selectionManagerService@setSelections -->
+     * selectionManagerService@_emitOnEnd -->
+     * _workbookSelections.selectionMoveEnd$ --> _addSelectionControlBySelectionData
+     *
+     *
+     * @param selectionData
+     */
+    protected _addSelectionControlBySelectionData(selection: ISelectionWithCoordAndStyle): void;
+    newSelectionControl(scene: Scene, _rangeType: RANGE_TYPE): SelectionControl;
+    updateControlForCurrentByRangeData(selections: ISelectionWithCoordAndStyle[]): void;
+    refreshSelectionMoveStart(): void;
+    protected _changeRuntime(skeleton: SpreadsheetSkeleton, scene: Scene, viewport?: Viewport): void;
+    getSkeleton(): SpreadsheetSkeleton;
+    getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[];
+    getSelectionControls(): SelectionControl[];
+    protected _clearSelectionControls(): void;
+    protected _getFreeze(): import('@univerjs/core').IFreeze | undefined;
+    protected _getViewportByCell(row?: number, column?: number): Viewport | null | undefined;
+    /**
+     * Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.
+     */
+    getActiveRange(): Nullable<IRange>;
+    /**
+     * get active selection control
+     * @returns T extends SelectionControl
+     */
+    getActiveSelectionControl<T extends SelectionControl = SelectionControl>(): Nullable<T>;
+    endSelection(): void;
+    protected _reset(): void;
+    resetAndEndSelection(): void;
+    /**
+     *
+     * @param evt component point event
+     * @param style selection style, Styles for user-customized selectors
+     * @param _zIndex Stacking order of the selection object
+     * @param rangeType Determines whether the selection is made normally according to the range or by rows and columns
+     */
+    protected _onPointerDown(evt: IPointerEvent | IMouseEvent, _zIndex?: number, rangeType?: RANGE_TYPE, viewport?: Viewport, scrollTimerType?: ScrollTimerType): false | undefined;
+    protected _setupPointerMoveListener(viewportMain: Nullable<Viewport>, activeSelectionControl: SelectionControl, rangeType: RANGE_TYPE, scrollTimerType: ScrollTimerType | undefined, moveStartPosX: number, moveStartPosY: number): void;
+    /** @deprecated Use the function `attachSelectionWithCoord` instead`. */
+    attachSelectionWithCoord(selectionWithStyle: ISelectionWithStyle): ISelectionWithCoordAndStyle;
+    /** @deprecated Use the function `attachPrimaryWithCoord` instead`. */
+    attachPrimaryWithCoord(primary: ISelectionCell): ISelectionCellWithMergeInfo;
+    getSelectionCellByPosition(x: number, y: number): Nullable<ISelectionCellWithMergeInfo>;
+    /**
+     * When mousedown and mouseup need to go to the coordination and undo stack, when mousemove does not need to go to the coordination and undo stack
+     */
+    protected _moving(offsetX: number, offsetY: number, activeSelectionControl: Nullable<SelectionControl>, rangeType: RANGE_TYPE): false | undefined;
+    protected _updateSelectionControlRange(control: SelectionControl, newSelectionRange: IRangeWithCoord, highlight: Nullable<ISelectionCellWithMergeInfo>): void;
+    protected _clearUpdatingListeners(): void;
+    protected _addEndingListeners(): void;
+    protected _getCellRangeByCursorPosition(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
+        x: number;
+        y: number;
+    }): Nullable<ISelectionWithCoord>;
+    protected _checkClearPreviousControls(evt: IPointerEvent | IMouseEvent): void;
+    private _performSelectionByTwoCells;
+}
+export declare function getAllSelection(skeleton: SpreadsheetSkeleton): ISelectionWithStyle;
+export declare function getTopLeftSelection(skeleton: SpreadsheetSkeleton): ISelectionWithStyle;

package/lib/types/services/selection/const.d.ts

@@ -0,0 +1,9 @@
+import { Scene, SpreadsheetSkeleton } from '@univerjs/engine-render';
+
+export declare const RANGE_MOVE_PERMISSION_CHECK: import('@univerjs/core').IInterceptor<boolean, null>;
+export declare const RANGE_FILL_PERMISSION_CHECK: import('@univerjs/core').IInterceptor<boolean, {
+    x: number;
+    y: number;
+    skeleton: SpreadsheetSkeleton;
+    scene: Scene;
+}>;

package/lib/types/services/selection/mobile-selection-render.service.d.ts

@@ -1,10 +1,10 @@
-import { IRange, IRangeWithCoord, ISelection, ISelectionCell, ISelectionCellWithMergeInfo, Nullable, InterceptorManager, RANGE_TYPE, ThemeService } from '@univerjs/core';
-import { IMouseEvent, IPointerEvent, Scene, SpreadsheetSkeleton, Viewport, IRenderManagerService } from '@univerjs/engine-render';
-import { ISelectionStyle, ISelectionWithCoordAndStyle, ISelectionWithStyle } from '@univerjs/sheets';
+import { Workbook, ICommandService, IContextService, ILogService, Injector, RANGE_TYPE, ThemeService } from '@univerjs/core';
+import { IMouseEvent, IPointerEvent, IRenderContext, IRenderModule, Scene, Viewport, IRenderManagerService } from '@univerjs/engine-render';
+import { SheetsSelectionsService } from '@univerjs/sheets';
 import { IShortcutService } from '@univerjs/ui';
-import { Injector } from '@wendellhu/redi';
-import { SelectionControl } from './selection-shape';
-import { IControlFillConfig, ISelectionRenderService } from './selection-render.service';
+import { SheetScrollManagerService } from '../scroll-manager.service';
+import { SheetSkeletonManagerService } from '../sheet-skeleton-manager.service';
+import { BaseSelectionRenderService } from './base-selection-render.service';
 import { MobileSelectionControl } from './mobile-selection-shape';
 
 declare enum ExpandingControl {
@@ -15,130 +15,26 @@ declare enum ExpandingControl {
     TOP = "top",
     BOTTOM = "bottom"
 }
-export declare class MobileSelectionRenderService implements ISelectionRenderService {
-    private readonly _themeService;
-    private readonly _shortcutService;
-    private readonly _renderManagerService;
-    private readonly _injector;
-    hasSelection: boolean;
-    private _pointerdownSub;
-    private _mainScenePointerUpSub;
-    private _scenePointerMoveSub;
-    private _scenePointerUpSub;
-    private _controlFillConfig$;
-    readonly controlFillConfig$: import('rxjs').Observable<IControlFillConfig | null>;
-    private _selectionControls;
-    private _activeCellRangeOfCurrSelection;
-    private _startOffsetX;
-    private _startOffsetY;
-    private _scrollTimer;
-    private _skeleton;
-    private _scene;
-    private _isHeaderHighlight;
-    private _isDetectMergedCell;
-    private _selectionStyle;
-    private _isSelectionEnabled;
-    private _isShowPreviousEnable;
-    private _isRemainLastEnable;
-    private _isSkipRemainLastEnable;
-    private _isSingleSelection;
-    private readonly _selectionMoveEnd$;
-    readonly selectionMoveEnd$: import('rxjs').Observable<ISelectionWithCoordAndStyle[]>;
-    private readonly _selectionMoving$;
-    /**
-     * Triggered during the drawing of the selection area.
-     */
-    readonly selectionMoving$: import('rxjs').Observable<ISelectionWithCoordAndStyle[]>;
-    private readonly _selectionMoveStart$;
-    /**
-     * Triggered during the start draw the selection area.
-     */
-    readonly selectionMoveStart$: import('rxjs').Observable<ISelectionWithCoordAndStyle[]>;
-    private _activeViewport;
-    /**
-     * This service relies on the scene and skeleton to work
-     * Use usable$ to check if this service works
-     */
-    private readonly _usable$;
-    readonly usable$: import('rxjs').Observable<boolean>;
-    interceptor: InterceptorManager<{
-        RANGE_MOVE_PERMISSION_CHECK: import('@univerjs/core').IInterceptor<boolean, null>;
-        RANGE_FILL_PERMISSION_CHECK: import('@univerjs/core').IInterceptor<boolean, {
-            x: number;
-            y: number;
-            skeleton: SpreadsheetSkeleton;
-            scene: Scene;
-        }>;
-    }>;
+export declare class MobileSheetsSelectionRenderService extends BaseSelectionRenderService implements IRenderModule {
+    private readonly _context;
+    private readonly _logService;
+    private readonly _commandService;
+    private readonly _contextService;
+    private readonly _sheetSkeletonManagerService;
+    private readonly _scrollManagerService;
+    private readonly _workbookSelections;
+    private _renderDisposable;
+    _expandingSelection: boolean;
+    protected _selectionControls: MobileSelectionControl[];
     expandingControlMode: ExpandingControl;
-    constructor(_themeService: ThemeService, _shortcutService: IShortcutService, _renderManagerService: IRenderManagerService, _injector: Injector);
-    enableHeaderHighlight(): void;
-    disableHeaderHighlight(): void;
-    enableDetectMergedCell(): void;
-    disableDetectMergedCell(): void;
-    setStyle(style: ISelectionStyle): void;
-    resetStyle(): void;
-    enableSelection(): void;
-    disableSelection(): void;
-    enableShowPrevious(): void;
-    disableShowPrevious(): void;
-    enableRemainLast(): void;
-    disableRemainLast(): void;
-    enableSkipRemainLast(): void;
-    disableSkipRemainLast(): void;
-    enableSingleSelection(): void;
-    disableSingleSelection(): void;
-    getViewPort(): Viewport;
-    /**
-     * add a selection
-     *
-     * in PC:init & pointerup would call this function.
-     *
-     * init
-     * selectionController@_initSkeletonChangeListener --> selectionManagerService.add --> selectionManagerService._selectionMoveEnd$ --> this.addControlToCurrentByRangeData
-     *
-     * selectionMoveEnd$ --> this.addSelectionControlBySelectionData
-     *
-     *
-     *
-     * pointer
-     * engine@_pointerDownEvent --> spreadsheet?.onPointerDownObserve --> eventTrigger --> scene@disableEvent() --> then scene.input-manager currentObject is always scene until scene@enableEvent.
-     * engine@_pointerUpEvent --> scene.input-manager@_onPointerUp --> this._selectionMoveEnd$ --> _selectionManagerService.selectionMoveEnd$ --> this.addControlToCurrentByRangeData
-     *
-     * but in mobile, we do not call disableEvent() in eventTrigger,
-     * so pointerup --> scene.input-manager currentObject is spreadsheet --> this.eventTrigger
-     *
-     *
-     *
-     * @param selectionData
-     */
-    addSelectionControlBySelectionData(selectionData: ISelectionWithCoordAndStyle): void;
-    newSelectionControl(scene: Scene, rangeType: RANGE_TYPE): MobileSelectionControl;
-    updateControlForCurrentByRangeData(selections: ISelectionWithCoordAndStyle[]): void;
-    refreshSelectionMoveStart(): void;
-    changeRuntime(skeleton: Nullable<SpreadsheetSkeleton>, scene: Nullable<Scene>, viewport?: Viewport): void;
-    getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[];
-    getSelectionControls(): SelectionControl[];
-    private _clearSelectionControls;
-    private _getFreeze;
-    private _getViewportByCell;
-    /**
-     * Returns the list of active ranges in the active sheet or null if there are no active ranges.
-     * If there is a single range selected, this method behaves like a getActiveRange() call.
-     */
-    getActiveSelections(): Nullable<ISelection[]>;
-    /**
-     * Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.
-     */
-    getActiveRange(): Nullable<IRange>;
-    /**
-     * get last selection control
-     */
-    getActiveSelectionControl(): Nullable<SelectionControl>;
-    endSelection(): void;
-    reset(): void;
-    resetAndEndSelection(): void;
-    expandingSelection: boolean;
+    constructor(_context: IRenderContext<Workbook>, injector: Injector, themeService: ThemeService, shortcutService: IShortcutService, renderManagerService: IRenderManagerService, selectionManagerService: SheetsSelectionsService, _logService: ILogService, _commandService: ICommandService, _contextService: IContextService, _sheetSkeletonManagerService: SheetSkeletonManagerService, _scrollManagerService: SheetScrollManagerService);
+    private _init;
+    private _initSkeletonChangeListener;
+    private _initSelectionChangeListener;
+    private _initEventListeners;
+    private _initSpreadsheetEvent;
+    private _initUserActionSyncListener;
+    private _updateSelections;
     /**
      * invoked when pointerup or longpress on spreadsheet, or pointerdown on row&col
      * then move curr selection to cell at cursor
@@ -148,32 +44,29 @@ export declare class MobileSelectionRenderService implements ISelectionRenderSer
      * @param rangeType
      * @param viewport
      */
-    eventTrigger(evt: IPointerEvent | IMouseEvent, _zIndex?: number, rangeType?: RANGE_TYPE, viewport?: Viewport): false | undefined;
+    createNewSelection(evt: IPointerEvent | IMouseEvent, _zIndex?: number, rangeType?: RANGE_TYPE, viewport?: Viewport): false | undefined;
     /**
-     *
-     * @param evt component point event
-     * @param style selection style, Styles for user-customized selectors
-     * @param zIndex Stacking order of the selection object
-     * @param rangeType Determines whether the selection is made normally according to the range or by rows and columns
-     *
-     * invoked by selection.render-controller@pointerDownObserver
-     *
-     * derived from eventTrigger
+     * Not same as PC version,
+     * new selection control for mobile do one more thing: bind event for two control points.
+     * @param scene
+     * @param rangeType
+     * @returns
      */
+    newSelectionControl(scene: Scene, rangeType: RANGE_TYPE): MobileSelectionControl;
+    private _getActiveViewport;
+    private _getSheetObject;
+    private _normalSelectionDisabled;
+    getSelectionControls(): MobileSelectionControl[];
     private _fillControlPointerDownHandler;
-    attachSelectionWithCoord(selectionWithStyle: ISelectionWithStyle): ISelectionWithCoordAndStyle;
-    attachRangeWithCoord(range: IRange): Nullable<IRangeWithCoord>;
-    attachPrimaryWithCoord(primary: Nullable<ISelectionCell>): Nullable<ISelectionCellWithMergeInfo>;
-    getSelectionCellByPosition(x: number, y: number): Nullable<ISelectionCellWithMergeInfo>;
-    /**
-     * When mousedown and mouseup need to go to the coordination and undo stack, when mousemove does not need to go to the coordination and undo stack
-     */
-    private _movingHandler;
+    private _changeCurrCellWhenControlPointerDown;
     /**
-     * rm pointerUp & pointerMove Observer on scene
+     * Not same as _moving in base selection render service
+     * The diff is
+     * In base version, new selection is determined by the cursor cell and _startRangeWhenPointerDown
+     *
+     * In Mobile version, new selection is determined by cursor cell and current of activeSelectionControl.model
      */
-    private _endSelection;
-    private _addCancelObserver;
-    private _getCellRangeByCursorPosition;
+    protected _moving(offsetX: number, offsetY: number, activeSelectionControl: MobileSelectionControl, rangeType: RANGE_TYPE): false | undefined;
+    private _updateControlPointWhenScrolling;
 }
 export {};

package/lib/types/services/selection/selection-render-model.d.ts

@@ -5,9 +5,6 @@ export declare class SelectionRenderModel implements IRangeWithCoord {
     private _startRow;
     private _endColumn;
     private _endRow;
-    /**
-     * value from { startY, endY, startX, endX } = getCellPositionByIndex in basics/tools
-     */
     private _startX;
     private _startY;
     private _endX;
@@ -17,47 +14,28 @@ export declare class SelectionRenderModel implements IRangeWithCoord {
      * when there is no merge info
      * top left cell of current selection (or bottomLeft of current selection)
      */
-    private _currentCell;
+    private _primary;
     private _rangeType;
     get startColumn(): number;
     get startRow(): number;
     get endColumn(): number;
     get endRow(): number;
-    /**
-     * value from { startY, endY, startX, endX } = getCellPositionByIndex in basics/tools
-     */
     get startX(): number;
-    /**
-     * value from { startY, endY, startX, endX } = getCellPositionByIndex in basics/tools
-     */
     get startY(): number;
-    /**
-     * value from { startY, endY, startX, endX } = getCellPositionByIndex in basics/tools
-     */
     get endX(): number;
-    /**
-     * value from { startY, endY, startX, endX } = getCellPositionByIndex in basics/tools
-     */
     get endY(): number;
-    /**
-     * highlight cell of selection
-     */
     get currentCell(): Nullable<ISelectionCellWithMergeInfo>;
     get rangeType(): RANGE_TYPE;
+    /**
+     * @deprecated, Duplicate with `Rectangle`
+     */
     isEqual(rangeWithCoord: IRangeWithCoord): boolean;
+    /**
+     * @deprecated, Duplicate with `Rectangle`
+     */
     isInclude(rangeWithCoord: IRangeWithCoord): boolean;
-    highlightToSelection(): Nullable<IRangeWithCoord>;
-    getRange(): {
-        startColumn: number;
-        startRow: number;
-        endColumn: number;
-        endRow: number;
-        startX: number;
-        startY: number;
-        endX: number;
-        endY: number;
-        rangeType: RANGE_TYPE;
-    };
+    highlightToSelection(): IRangeWithCoord | undefined;
+    getRange(): IRangeWithCoord;
     getCell(): Nullable<ISelectionCellWithMergeInfo>;
     getRangeType(): RANGE_TYPE;
     setRangeType(rangeType: RANGE_TYPE): void;