Class GscapeContextMenu

Hierarchy

IContextualWidgetMixin<this> & IBaseMixin<this> & LitElement<this>
- GscapeContextMenu

Index

Constructors

Properties

commands customElements cxtWidgetProps enabled isVisible loading showFirst subMenus tippyWidget properties styles

Accessors

commandsTemplate customElementsTemplate

Methods

attachTo attachToPosition attachToSilently disable enable handleCommandClick hide hideSubMenu onCommandRun onStateChange render show showInPosition showSubMenu

Constructors

constructor

new GscapeContextMenu(): GscapeContextMenu
Returns GscapeContextMenu
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).constructor
- Defined in node_modules/@lit/reactive-element/reactive-element.d.ts:487

Properties

commands

commands: Command[] = []

customElements

customElements: (HTMLElement | LitElement | TemplateResult<ResultType>)[] = []

cxtWidgetProps

cxtWidgetProps: Partial<Props>

enabled

enabled: boolean

isVisible

isVisible: boolean

loading

loading: boolean = false

showFirst

showFirst: "elements" | "commands" = 'elements'

`Private` subMenus

subMenus: Map<string, GscapeContextMenu> = ...

tippyWidget

tippyWidget: Instance<Props>

`Static` properties

properties: PropertyDeclarations = ...

`Static` styles

styles: CSSResultArray = ...

Accessors

`Private` commandsTemplate

get commandsTemplate(): undefined | TemplateResult<1>
Returns undefined | TemplateResult<1>
- Defined in src/ui/common/context-menu.ts:160

`Private` customElementsTemplate

get customElementsTemplate(): undefined | TemplateResult<1>
Returns undefined | TemplateResult<1>
- Defined in src/ui/common/context-menu.ts:231

Methods

attachTo

attachTo(element: HTMLElement, commands?: Command[], elements?: (HTMLElement | LitElement | TemplateResult<ResultType>)[]): void
Parameters
- element: HTMLElement
- Optional commands: Command[]
- Optional elements: (HTMLElement | LitElement | TemplateResult<ResultType>)[]
Returns void
Overrides ContextualWidgetMixin(BaseMixin(LitElement)).attachTo
- Defined in src/ui/common/context-menu.ts:114

attachToPosition

attachToPosition(position: {
x: number;
y: number;
}, container: Element, commands?: Command[], elements?: (HTMLElement | LitElement | TemplateResult<ResultType>)[]): void
Parameters
- position: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- container: Element
- Optional commands: Command[]
- Optional elements: (HTMLElement | LitElement | TemplateResult<ResultType>)[]
Returns void
- Defined in src/ui/common/context-menu.ts:121

attachToSilently

attachToSilently(element: HTMLElement): void
Attach cxt widget and do not show it, if it was visible it stays visible
Parameters
- element: HTMLElement
  
  the target html element
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).attachToSilently
- Defined in src/ui/common/mixins/contextual-widget-mixin.ts:17

disable

disable(): void
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).disable
- Defined in src/ui/common/mixins/base-widget-mixin.ts:10

enable

enable(): void
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).enable
- Defined in src/ui/common/mixins/base-widget-mixin.ts:9

`Private` handleCommandClick

handleCommandClick(e: any): void
Parameters
- e: any
Returns void
- Defined in src/ui/common/context-menu.ts:151

hide

hide(): void
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).hide
- Defined in src/ui/common/mixins/contextual-widget-mixin.ts:7

hideSubMenu

hideSubMenu(commandID: string): void
Parameters
- commandID: string
Returns void
- Defined in src/ui/common/context-menu.ts:223

onCommandRun

onCommandRun(): void
Returns void
- Defined in src/ui/common/context-menu.ts:30

onStateChange

onStateChange(): void
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).onStateChange
- Defined in src/ui/common/mixins/base-widget-mixin.ts:11

render

render(): TemplateResult<1>
Returns TemplateResult<1>
Overrides ContextualWidgetMixin(BaseMixin(LitElement)).render
- Defined in src/ui/common/context-menu.ts:89

show

show(): void
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).show
- Defined in src/ui/common/mixins/base-widget-mixin.ts:7

showInPosition

showInPosition(position?: {
x: number;
y: number;
}): void
Parameters
- Optional position: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
Returns void
Inherited from ContextualWidgetMixin(BaseMixin(LitElement)).showInPosition
- Defined in src/ui/common/mixins/base-widget-mixin.ts:8

`Private` showSubMenu

showSubMenu(command: Command, commandID: string): void
Parameters
- command: Command
- commandID: string
Returns void
- Defined in src/ui/common/context-menu.ts:191