Optional params: AnyDictPrivate __trackRest ...params: any[]Private _autoPrivate _autoPrivate _lastOptional _lastPrivate _lastOptional _layoutPrivate _layoutOptional _needsPrivate _previousOptional canvasOptional closedivOptional e: NotifyEventOptional focusOptional forceOptional itemOptional startOptional touchGets/sets context menu of the control. It could be also a function returning Menu object.
Gets/sets data-disabled attribute of the control and his childs
Gets/sets dock menu of the control. It could be also a function returning Menu object.
Gets/sets dock title.
Gets/sets dockable status of the control.
Gets/sets isDock status of the control.
Get/set whether this control is searchable (e.g. via search bar)
Gets/sets tabIndex property. Use instead of tabIndex in HTMLElement for correct handling of disabled state.
Gets/sets visibility state of the control.
Creates a new sub-control.
Class of the new control.
Optional initParams: AnyDictInitialization parameters.
The new control.
addControl
Control is allow drop objects.
true if dragged object can be dropped here
canDrop
Handle drag enter operation
dragEnter
Optional e: NotifyEventHandle drag leave operation
dragLeave
Handle drag over operation
dragOver
Handle drop operation
Optional isSameControl: booleandrop
Gets new drop mode
Drop mode
getDropMode
Returns the first ancestor in the HTML DOM tree, that has controlClass and data-id. Searching is stopped on topParentCtrl, if defined.
ControlClass of the top parent, where to stop searching.
Parent Control or undefined if there's no parent.
getParentControl
This method is pretty similar as app.listen(), but app.unlisten() is called automatically in Control.cleanUp()
Object where to set listener
Event of the listener
Method for callback dispatch
Optional capture: booleanRest ...args: any[]localListen
Raise the event on the Control
Name of the event
Optional details: AnyDictCustom parameters to be sent with the event
Optional isCancelable: booleanWhether the event can be canceled.
Optional canBubble: booleanWhether the event can bubble.
Optional sender: EventTargetof the event. Container by default.
Success. If 'false', the event was canceled.
if (!this.raiseEvent('selecting', {
tabIndex: value,
oldTabIndex: oldSelected
}, true))
return; // canceled, do not change selection
Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.
Callback to run.
Optional callbackID: stringOptional ID for callback, so that multiple instances of the callback do not execute at the same time.
this.requestFrame(function () {
// this callback will be executed at a maximum of your monitor's natural refresh rate.
}, "myUniqueFrameCallbackName");
Request an animation frame in the control context, with the same features as requestAnimationFrameMM(). If the control has been cleaned up, then the callback will not execute.
Callback to run.
Optional callbackID: stringOptional ID for callback, so that multiple instances of the callback do not execute at the same time.
this.requestFrame(function () {
// this callback will be executed at a maximum of your monitor's natural refresh rate when focused, maximum of 30 fps when not focused, and maximum of 2 fps when window is not visible.
}, "myUniqueFrameCallbackName");
requestFrameMM
Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls
Callback, which should be called when idle
Optional callbackID: stringString name, which identifies the callback. If present, it cancels the previous sheduled callback
Optional useFirst: booleanValid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked
requestIdle
Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls
Callback, which should be called after timeout
Timeout, in ms
Optional callbackID: stringString name, which identifies the callback. If present, it cancels the previous sheduled callback
Optional useFirst: booleanValid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked
requestTimeout
Restores state of the control and all its subcontrols having data-id specified.
hierarchical object including states of the control and the subcontrols
Optional isJustViewModeChange: booleanrestoreState
Stores state of the control and all its subcontrols having data-id specified.
hierarchical object including states of the control and the subcontrols
storeState
Method for handling Promise with delayed progress.
Passed promise
Optional params: anyObject with possible parameters:
thenWithProgress
Lyrics window element
LyricsWindow