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

Class. Edit Label Ui

containerElement

protected containerElement: HTMLElement

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

Inherited from

AbstractUIExtension.containerElement


domHelper

protected domHelper: DOMHelper

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:56


inputElement

protected inputElement: HTMLInputElement

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:60


isActive

protected isActive: boolean = false

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:66


isCurrentLabelValid

protected isCurrentLabelValid: boolean = true

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:68


label?

protected optional label: EditableLabel & SModelElementImpl

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:63


labelElement

protected labelElement: null | HTMLElement

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:64


labelValidator

labelValidator: IEditLabelValidator

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:57


logger

protected logger: ILogger

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

Inherited from

AbstractUIExtension.logger


options

protected options: ViewerOptions

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

Inherited from

AbstractUIExtension.options


previousLabelContent?

protected optional previousLabelContent: string

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:69


textAreaElement

protected textAreaElement: HTMLTextAreaElement

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:61


validationDecorator

validationDecorator: IEditLabelValidationDecorator

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:58


validationTimeout?

protected optional validationTimeout: number = undefined

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:65


viewerOptions

protected viewerOptions: ViewerOptions

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:55


ID

readonly static ID: "editLabelUi" = 'editLabelUi'

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:52

Accessors

editControl

Get Signature

get editControl(): HTMLInputElement | HTMLTextAreaElement

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:97

Returns

HTMLInputElement | HTMLTextAreaElement


labelId

Get Signature

get protected labelId(): string

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:74

Returns

string

Methods

applyFontStyling()

protected applyFontStyling(): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:246

Returns

void


applyLabelEdit()

protected applyLabelEdit(): Promise<void>

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:122

Returns

Promise<void>


applyLabelEditOnEvent()

protected applyLabelEditOnEvent(event, code?, …modifiers?): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:108

Parameters

event

KeyboardEvent

code?

KeyCode

modifiers?

KeyboardModifier[]

Returns

void


applyTextContents()

protected applyTextContents(): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:232

Returns

void


clearValidationResult()

protected clearValidationResult(): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:173

Returns

void


configureAndAdd()

protected configureAndAdd(element, containerElement): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:86

Parameters

element

HTMLInputElement | HTMLTextAreaElement

containerElement

HTMLElement

Returns

void


containerClass()

containerClass(): string

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:72

Returns

string

Overrides

AbstractUIExtension.containerClass


getOrCreateContainer()

protected getOrCreateContainer(baseDivId): HTMLElement

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

Parameters

baseDivId

string

Returns

HTMLElement

Inherited from

AbstractUIExtension.getOrCreateContainer


hide()

hide(): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:187

Returns

void

Overrides

AbstractUIExtension.hide


hideIfEscapeEvent()

protected hideIfEscapeEvent(event): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:104

Parameters

event

KeyboardEvent

Returns

void


id()

id(): string

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:71

Returns

string

Overrides

AbstractUIExtension.id


initialize()

protected initialize(): boolean

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

Returns

boolean

Inherited from

AbstractUIExtension.initialize


initializeContents()

protected initializeContents(containerElement): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:76

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

Overrides

AbstractUIExtension.initializeContents


onBeforeShow()

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

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:199

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

Overrides

AbstractUIExtension.onBeforeShow


performLabelValidation()

protected performLabelValidation(event, value): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:144

Parameters

event

KeyboardEvent

value

string

Returns

void


restoreFocus()

protected restoreFocus(): void

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

Returns

void

Inherited from

AbstractUIExtension.restoreFocus


setContainerVisible()

protected setContainerVisible(visible): void

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

Parameters

visible

boolean

Returns

void

Inherited from

AbstractUIExtension.setContainerVisible


setPosition()

protected setPosition(containerElement): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:209

Parameters

containerElement

HTMLElement

Returns

void


show()

show(root, …contextElementIds): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:179

Parameters

root

Readonly<SModelRootImpl>

contextElementIds

string[]

Returns

void

Overrides

AbstractUIExtension.show


showValidationResult()

protected showValidationResult(result): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:166

Parameters

result

EditLabelValidationResult

Returns

void


validateLabel()

protected validateLabel(value): Promise<EditLabelValidationResult>

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:151

Parameters

value

string

Returns

Promise<EditLabelValidationResult>


validateLabelIfContentChange()

protected validateLabelIfContentChange(event, value): void

Defined in: packages/sprotty/src/features/edit/edit-label-ui.ts:115

Parameters

event

KeyboardEvent

value

string

Returns

void