Sprotty
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Class. Abstract Uiextension

options

protected options: ViewerOptions

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:44

Methods

containerClass()

abstract containerClass(): string

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:51

Returns

string


getOrCreateContainer()

protected getOrCreateContainer(baseDivId): HTMLElement

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:89

Parameters

baseDivId

string

Returns

HTMLElement


hide()

hide(): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:62

Returns

void

Implementation of

IUIExtension.hide


id()

abstract id(): string

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:50

Returns

string

Implementation of

IUIExtension.id


initialize()

protected initialize(): boolean

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:75

Returns

boolean


initializeContents()

abstract protected initializeContents(containerElement): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:127

Initializes the contents of this UI extension.

Subclasses must implement this method to initialize the UI elements of this UI extension inside the specified containerElement.

Parameters

containerElement

HTMLElement

Returns

void


onBeforeShow()

protected onBeforeShow(containerElement, root, …contextElementIds): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:118

Updates the containerElement under the given context before it becomes visible.

Subclasses may override this method to, for instance, modifying the position of the containerElement, add or remove elements, etc. depending on the specified root or contextElementIds.

Parameters

containerElement

HTMLElement

root

Readonly<SModelRootImpl>

contextElementIds

string[]

Returns

void


restoreFocus()

protected restoreFocus(): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:68

Returns

void


setContainerVisible()

protected setContainerVisible(visible): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:99

Parameters

visible

boolean

Returns

void


show()

show(root, …contextElementIds): void

Defined in: packages/sprotty/src/base/ui-extensions/ui-extension.ts:53

Parameters

root

Readonly<SModelRootImpl>

contextElementIds

string[]

Returns

void

Implementation of

IUIExtension.show