Private _fixedOptional _lastOptional _layoutOptional _needsOptional 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.
Specifies whether all tabs have the same width (given by 'fixedWidth' css class).
Gets/sets isDock status of the control.
Get/set whether this control is searchable (e.g. via search bar)
Array of all tab headers (HTML elements <li>)
Returns the number of tabs.
Gets/sets the currently selected tab (by its index).
Gets/sets the currently selected tab (by its data-id).
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.
addControl
Class of the new control.
Optional initParams: AnyDictInitialization parameters.
The new control.
Optional e: NotifyEventHandle drag enter operation
dragEnter
Optional e: NotifyEventReturns the first ancestor in the HTML DOM tree, that has controlClass and data-id. Searching is stopped on topParentCtrl, if defined.
getParentControl
ControlClass of the top parent, where to stop searching.
Parent Control or undefined if there's no parent.
This method is called for each newly added tab header.
initializeTab
Tab item to be initialized
Inserts a new tab at a specified position.
insertTab
Index where to insert the new tab
Optional title: anyTitle of the new tab
Optional contentPanel: anyThe new panel
Optional icon: anyIcon name
The new tab element (<li>).
This method is pretty similar as app.listen(), but app.unlisten() is called automatically in Control.cleanUp()
localListen
Object where to set listener
Event of the listener
Method for callback dispatch
Optional capture: booleanRest ...args: any[]Raise the event on the Control
if (!this.raiseEvent('selecting', {
tabIndex: value,
oldTabIndex: oldSelected
}, true))
return; // canceled, do not change selection
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.
Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.
this.requestFrame(function () {
// this callback will be executed at a maximum of your monitor's natural refresh rate.
}, "myUniqueFrameCallbackName");
Callback to run.
Optional callbackID: stringOptional ID for callback, so that multiple instances of the callback do not execute at the same time.
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.
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
Callback to run.
Optional callbackID: stringOptional ID for callback, so that multiple instances of the callback do not execute at the same time.
Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls
requestIdle
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
Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls
requestTimeout
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
Restores state of the control and all its subcontrols having data-id specified.
restoreState
hierarchical object including states of the control and the subcontrols
Optional isJustViewModeChange: booleanStores state of the control and all its subcontrols having data-id specified.
storeState
hierarchical object including states of the control and the subcontrols
Method for handling Promise with delayed progress.
thenWithProgress
Passed promise
Optional params: anyObject with possible parameters:
UI Tabs element