Widget class
Represents a widget - a visual element with “knows” how to render itself. Some widgets just display some information from the context (like the generated SQL or the result set). Others - allow user to interact with them to define query conditions or columns.
Constructors
Section titled “Constructors”constructor
Section titled “constructor”Initializes a new instance of the Widget class
⊕ new Widget(slot: HTMLElement): Widget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- an HTML element in which we should place our widget.
Public Properties
Section titled “Public Properties”widgetType
Section titled “widgetType”● widgetType: string
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● group: WidgetGroup
● slot: HTMLElement
Public Methods
Section titled “Public Methods”belongsToGroup
Section titled “belongsToGroup”Returns true if the widget belongs to one of the groups specified in the parameter
▸ belongsToGroup(groups?: WidgetGroup): boolean
Parameters:
Section titled “Parameters:”- groups: WidgetGroup, Optional -
Returns boolean
destroy
Section titled “destroy”▸ destroy(): void
Returns void
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
Initializes the widget and assign it to some context
▸ init(context: EqContext,options?: any): void
Parameters:
Section titled “Parameters:”- context: EqContext
- options:
any, Optional -
Returns void
onProcessEnd
Section titled “onProcessEnd”This function is called on the end of some process this widget participates in. For example, some widgets should be updated on model loading or after the execution of the current query
▸ onProcessEnd(): void
Returns void
onProcessStart
Section titled “onProcessStart”This function is called on the start of some process this widget participates in. For example, some widgets can show a spinner or a progress bar at the beginning of some long process (e.g. model loading).
▸ onProcessStart(): void
Returns void
refresh
Section titled “refresh”Refreshes the widget’s content
▸ refresh(): void
Returns void
Protected Methods
Section titled “Protected Methods”destroyCore
Section titled “destroyCore”▸ destroyCore(): void
Returns void
onProcessEndCore
Section titled “onProcessEndCore”This function is called from onProcessEnd function.
It does nothing in the base Widget class
but can be overridden in derived classes
to implement the functionality specific for a particular widget.
▸ onProcessEndCore(): void
Returns void
onProcessStartCore
Section titled “onProcessStartCore”This function is called from onProcessStart function.
It does nothing in the base Widget class
but can be overridden in derived classes
to implement the functionality specific for a particular widget.
▸ onProcessStartCore(): void
Returns void
refreshCore
Section titled “refreshCore”This function is called from refresh function.
It does nothing in the base Widget class
but can be overridden in derived classes
to implement the functionality specific for a particular widget
▸ refreshCore(): void
Returns void