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.
Index
Constructors
Public Properties
Protected Properties
Public Methods
Protected Methods
Constructors
constructor
Initializes a new instance of the Widget class
⊕ new Widget(slot: HTMLElement): Widget
Parameters:
- slot:
HTMLElement- an HTML element in which we should place our widget.
Public Properties
widgetType
● widgetType: string
Protected Properties
context
● context: EqContext
group
● group: WidgetGroup
Public Methods
belongsToGroup
Returns true if the widget belongs to one of the groups specified in the parameter
▸ belongsToGroup(groups?: WidgetGroup): boolean
Parameters:
- groups: WidgetGroup, Optional -
Returns boolean
getContext
Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
init
Initializes the widget and assign it to some context
▸ init(context: EqContext,options?: any): void
Parameters:
- context: EqContext
- options:
any, Optional -
Returns void
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
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
Refreshes the widget's content
▸ refresh(): void
Returns void
Protected Methods
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
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
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