@univerjsuiindexclassesDesktoplayoutservice

@univerjs/ui v0.5.4


Class: DesktopLayoutService

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:61

This service is responsible for storing layout information of the current Univer application instance.

Extends

Implements

Constructors

new DesktopLayoutService()

new DesktopLayoutService(_contextService, _univerInstanceService): DesktopLayoutService

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:75

Parameters

ParameterType
_contextServiceContextService
_univerInstanceServiceIUniverInstanceService

Returns

DesktopLayoutService

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96

Accessors

isFocused

Get Signature

get isFocused(): boolean

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:65

Returns

boolean

Implementation of

ILayoutService.isFocused


rootContainerElement

Get Signature

get rootContainerElement(): Nullable<HTMLElement>

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:85

Returns

Nullable<HTMLElement>

Implementation of

ILayoutService.rootContainerElement

Methods

checkContentIsFocused()

checkContentIsFocused(): boolean

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:158

Returns

boolean

Implementation of

ILayoutService.checkContentIsFocused


checkElementInCurrentContainers()

checkElementInCurrentContainers(element): boolean

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:154

Parameters

ParameterType
elementHTMLElement

Returns

boolean

Implementation of

ILayoutService.checkElementInCurrentContainers


dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


focus()

focus(): void

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:89

Re-focus the currently focused Univer business instance.

Returns

void

Implementation of

ILayoutService.focus


getContentElement()

getContentElement(): HTMLElement

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:127

Returns

HTMLElement

Implementation of

ILayoutService.getContentElement


registerContainerElement()

registerContainerElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:145

Register an element as a container, especially floating components like Dialogs and Notifications.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable

Implementation of

ILayoutService.registerContainerElement


registerContentElement()

registerContentElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:118

Register a content element.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable

Implementation of

ILayoutService.registerContentElement


registerFocusHandler()

registerFocusHandler(type, handler): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:109

Register a focus handler to focus on certain type of Univer unit.

Parameters

ParameterType
typeUniverInstanceType
handlerFocusHandlerFn

Returns

IDisposable

Implementation of

ILayoutService.registerFocusHandler


registerRootContainerElement()

registerRootContainerElement(container): IDisposable

Defined in: submodules/univer/packages/ui/src/services/layout/layout.service.ts:131

Register the root container element.

Parameters

ParameterType
containerHTMLElement

Returns

IDisposable

Implementation of

ILayoutService.registerRootContainerElement