UI GenreViewHeader element

Hierarchy

Properties

UI __preDataSource __preSource __preSourceFiltered _canBeLongTouch _captureListeners _cleanFuncs _cleanUpCalled _contextMenu _contextMenuAddons _contextMenuHandler _controlTitle _dataSource _dataSourceListenFuncts _dataSourceOrig _dataSourcePromises _disabled _dockMenuItems _dockable _ds _frameIDs _frameMMIDs _gettingImagePending _hasSplitters _idleCallIDs _ignoreDefaultLookup _imageCtrl _isDock _isFiltered _isLongTouch _isresizable _lastKey? _lastMousePos _layoutChangeHandler? _listeners _localPromises _menuArray _mouseMoveHandler _mouseOutHandler _needsFullRecalculation? _originalHeight _originalWidth _parentView _pointerAtPos _promises _resizeStartX _resizeStartY _resizing _searchable _setFilteredSourceTm _statusBarPromises _statusBarSources _statusParams _tabIndex _timeoutIDs _touchDownTime _triedLocalImage activatedHandler addArtworkRules artworkExactSizeClass artworkSizeClass bigHeader biggerHeaderHeight canBeUsedAsSource canvas? closediv? container contextMenuPromise currentMode debugMenuItemsCreated defaultBtn descEditSupport disableStateStoring disabledCounter disabledOnline dndEventsRegistered dragEnterHandler dragFinishedHandler dragLeaveHandler dragOverHandler dragStartHandler dragging dropHandler editSupported excludeFromGlobalContextualSearch findDNDHandler focusEventsRegistered? forceDisabled? genres getCloseButtonAction headerAnimating headerHeightClass headerMinHeightClass icon imgUrl itemCount? lastHeaderHeight lastWikiShowingOnline mbDataType mergeParentContextMenu noFocusOnClick noMatchFilled parenthesis readingWiki resizediv setCloseButtonAction showingOnline slightlyOverflowedHeader startEdit? statusInfo thumbToken title touchEnd touchEventsRegistered? touchMove touchStart uniqueID useCollage useGenres useImage useMenuButton usePlayButton useShuffleButton useSourceSwitcher wikiUrl wikidesc wikipages

Accessors

Methods

_handle_layoutchange _notifyFiltered _updateDisabledAttribute addCleanFunc addControl addEventListener addToContextMenu canDrawFocus canDrop canFocus cancelAll cancelDataSourcePromises checkedCleanUp cleanUp cleanUpPromises cleanUpStatusBarSources clearData clearFilterSource contextMenuHandler dataSourceChangeHandler dataSourceListen dataSourcePromise dataSourceUnlistenFuncts dragEnter dragFinished dragLeave dragOver drop editStart enableDragNDrop enableTouch fileTransferPrepare filterSource focusHandler focusIn focusRefresh formatStatus getContextMenuItems getDescription getDragDataType getDraggedObject getDropMode getFocusedElement getParentControl getParenthesis getPersistentStateRootControl getPersistentStateRootKey getPersistentStateRootKeyBase getTitle getTracklist handle_layoutchange initialize isFiltered localListen localPromise longTouch makeDraggable notfiySizeCouldChanged notifyControlFocus openView qChild raiseEvent registerEventHandler registerStatusBarSource removeEventListener requestFrame requestFrameMM requestIdle requestTimeout restorePersistentState restorePersistentStates restoreState safeEndTask sendStatus setChildsDisabled setDefaults setDisabledFromParent setDragElementData setEditMode setFocus setFocusedAndSelectedIndex setItemFullyVisible setItemFullyVisibleCentered setStatus setWikiLanguage startEditTitle stopEditTitle storePersistentState storePersistentStates storeState thenWithProgress unregisterDragDrop unregisterEventHandler unregisterFocusEvents unregisterStatusBarSource unregisterTouchEvents updateImage updateValues

Constructors

Properties

UI: {
    [key: string]: HTMLElement;
}

Undocumented

Type declaration

  • [key: string]: HTMLElement
__preDataSource: any

Undocumented

__preSource: any

Undocumented

__preSourceFiltered: any

Undocumented

_canBeLongTouch: any

Undocumented

_captureListeners: any

Undocumented

_cleanFuncs: any

Undocumented

_cleanUpCalled: boolean

Undocumented

_contextMenu: any

Undocumented

_contextMenuAddons: any

Undocumented

_contextMenuHandler: any

Undocumented

_controlTitle: string

Undocumented

_dataSource: any

Undocumented

_dataSourceListenFuncts: (() => void)[]

Undocumented

_dataSourceOrig: any

Undocumented

_dataSourcePromises: any

Undocumented

_disabled: boolean

Undocumented

_dockMenuItems: any

Undocumented

_dockable: boolean

Undocumented

_ds: any

Undocumented

_frameIDs: any

Undocumented

_frameMMIDs: any

Undocumented

_gettingImagePending: boolean

Undocumented

_hasSplitters: boolean

Undocumented

_idleCallIDs: any

Undocumented

_ignoreDefaultLookup: any

Undocumented

_imageCtrl: ArtworkRectangle

Undocumented

_isDock: boolean

Undocumented

_isFiltered: boolean

Undocumented

_isLongTouch: any

Undocumented

_isresizable: boolean

Undocumented

_lastKey?: string

Undocumented

_lastMousePos: {
    x: any;
    y: any;
}

Undocumented

Type declaration

  • x: any

    Undocumented

  • y: any

    Undocumented

_layoutChangeHandler?: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_listeners: any

Undocumented

_localPromises: Promise<any>[]

Undocumented

_menuArray: Action[]

Undocumented

_mouseMoveHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_mouseOutHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_needsFullRecalculation?: boolean

Undocumented

_originalHeight: number

Undocumented

_originalWidth: number

Undocumented

_parentView: ViewData

Undocumented

_pointerAtPos: any

Undocumented

_promises: AnyDict

Undocumented

_resizeStartX: number

Undocumented

_resizeStartY: number

Undocumented

_resizing: boolean

Undocumented

_searchable: boolean

Undocumented

_setFilteredSourceTm: any

Undocumented

_statusBarPromises: any

Undocumented

_statusBarSources: any

Undocumented

_statusParams: AnyDict

Undocumented

_tabIndex: number

Undocumented

_timeoutIDs: any

Undocumented

_touchDownTime: any

Undocumented

_triedLocalImage: boolean

Undocumented

activatedHandler: ((active) => void)

Type declaration

    • (active): void
    • Undocumented

      Parameters

      • active: boolean

      Returns void

addArtworkRules: any

Undocumented

artworkExactSizeClass: string

Undocumented

artworkSizeClass: string

Undocumented

bigHeader: boolean

Undocumented

biggerHeaderHeight: number

Undocumented

canBeUsedAsSource: boolean

Undocumented

canvas?: any

Undocumented

closediv?: HTMLDivElement

Undocumented

container: HTMLElement

Undocumented

contextMenuPromise: any

Undocumented

currentMode: any

Undocumented

debugMenuItemsCreated: any

Undocumented

defaultBtn: HTMLElement

Undocumented

descEditSupport: boolean

Undocumented

disableStateStoring: boolean

Undocumented

disabledCounter: number

Undocumented

disabledOnline: any

Undocumented

dndEventsRegistered: boolean

Undocumented

dragEnterHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragFinishedHandler: ((e?) => void)

Type declaration

    • (e?): void
    • Undocumented

      Parameters

      Returns void

dragLeaveHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragOverHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragStartHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragging: boolean

Undocumented

dropHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      • e: any

      Returns void

editSupported: boolean

Undocumented

excludeFromGlobalContextualSearch: boolean

Undocumented

findDNDHandler: ((e) => any)

Type declaration

    • (e): any
    • Undocumented

      Parameters

      Returns any

focusEventsRegistered?: boolean

Undocumented

forceDisabled?: boolean

Undocumented

genres: any

Undocumented

getCloseButtonAction: (() => any)

Type declaration

    • (): any
    • Undocumented

      Returns any

headerAnimating: any

Undocumented

headerHeightClass: string

Undocumented

headerMinHeightClass: string

Undocumented

icon: string

Undocumented

imgUrl: any

Undocumented

itemCount?: number

Undocumented

lastHeaderHeight: any

Undocumented

lastWikiShowingOnline: boolean

Undocumented

mbDataType: any

Undocumented

mergeParentContextMenu: any

Undocumented

noFocusOnClick: any

Undocumented

noMatchFilled: boolean

Undocumented

parenthesis: any

Undocumented

readingWiki: boolean

Undocumented

resizediv: HTMLDivElement

Undocumented

setCloseButtonAction: ((action) => void)

Type declaration

    • (action): void
    • Undocumented

      Parameters

      Returns void

showingOnline: boolean

Undocumented

slightlyOverflowedHeader: boolean

Undocumented

startEdit?: procedure

Undocumented

statusInfo: any

Undocumented

thumbToken: any

Undocumented

title: any

Undocumented

touchEnd: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchEventsRegistered?: boolean

Undocumented

touchMove: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchStart: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

uniqueID: string

Undocumented

useCollage: boolean

Undocumented

useGenres: boolean

Undocumented

useImage: boolean

Undocumented

useMenuButton: boolean

Undocumented

usePlayButton: boolean

Undocumented

useShuffleButton: boolean

Undocumented

useSourceSwitcher: boolean

Undocumented

wikiUrl: any

Undocumented

wikidesc: any

Undocumented

wikipages: any

Undocumented

Accessors

  • get contextMenu(): any
  • Gets/sets context menu of the control. It could be also a function returning Menu object.

    Returns any

  • set contextMenu(value): void
  • Parameters

    • value: any

    Returns void

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

  • get disabled(): boolean
  • Gets/sets data-disabled attribute of the control and his childs

    Returns boolean

  • set disabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get dockMenuItems(): any
  • Gets/sets dock menu of the control. It could be also a function returning Menu object.

    Returns any

  • set dockMenuItems(value): void
  • Parameters

    • value: any

    Returns void

  • get dockTitle(): string
  • Gets/sets dock title.

    Returns string

  • set dockTitle(value): void
  • Parameters

    • value: string

    Returns void

  • get dockable(): boolean
  • Gets/sets dockable status of the control.

    Returns boolean

  • set dockable(value): void
  • Parameters

    • value: boolean

    Returns void

  • get genre(): any
  • Returns any

  • get hasSplitters(): boolean
  • Returns boolean

  • set hasSplitters(value): void
  • Parameters

    • value: boolean

    Returns void

  • get helpContext(): string
  • Returns string

  • set helpContext(value): void
  • Parameters

    • value: string

    Returns void

  • get isDock(): boolean
  • Gets/sets isDock status of the control.

    Returns boolean

  • set isDock(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isSearchable(): boolean
  • Get/set whether this control is searchable (e.g. via search bar)

    Returns boolean

  • set isSearchable(value): void
  • Parameters

    • value: boolean

    Returns void

  • Returns any[]

  • Parameters

    • value: any[]

    Returns void

  • get minHeight(): number
  • Returns number

  • set minHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get minWidth(): number
  • Returns number

  • set minWidth(value): void
  • Parameters

    • value: number

    Returns void

  • get multiselect(): boolean
  • Returns boolean

  • set multiselect(value): void
  • Parameters

    • value: boolean

    Returns void

  • get parentView(): ViewData
  • Gets/sets view data.

    Returns ViewData

  • set parentView(value): void
  • Parameters

    Returns void

  • get resizable(): boolean
  • Returns boolean

  • set resizable(val): void
  • Parameters

    • val: boolean

    Returns void

  • get selectionMode(): boolean
  • Returns boolean

  • set selectionMode(value): void
  • Parameters

    • value: boolean

    Returns void

  • get statusParams(): AnyDict
  • Gets/sets params for statusbar.

    Returns AnyDict

  • set statusParams(value): void
  • Parameters

    Returns void

  • get tabIndex(): number
  • Gets/sets tabIndex property. Use instead of tabIndex in HTMLElement for correct handling of disabled state.

    Returns number

  • set tabIndex(value): void
  • Parameters

    • value: number

    Returns void

  • get visible(): boolean
  • Gets/sets visibility state of the control.

    Returns boolean

Methods

  • Undocumented

    Parameters

    • evt: any

    Returns void

  • Undocumented

    Parameters

    • orig: any
    • filtered: any
    • phrase: any

    Returns void

  • Add function to be called once during Control cleanUp

    Method

    addCleanFunc

    Parameters

    • func: any

      Function to add

    Returns void

  • Creates a new sub-control.

    Method

    addControl

    Parameters

    • controlClass: string

      Class of the new control.

    • Optional initParams: AnyDict

      Initialization parameters.

    Returns HTMLDivElement

    The new control.

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Adds item(s) to control context menu.

    Method

    addToContextMenu

    Parameters

    • items: any

    Returns void

  • Undocumented

    Returns boolean

  • Control is allow drop objects.

    Method

    canDrop

    Parameters

    Returns boolean

    true if dragged object can be dropped here

  • Undocumented

    Returns boolean

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • params: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • e: any

    Returns void

  • Undocumented

    Parameters

    • params: any

    Returns void

  • Undocumented

    Parameters

    • object: any
    • event: any
    • func: any
    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • Undocumented

    Parameters

    • pr: any

    Returns any

  • Handle drag enter operation

    Method

    dragEnter

    Parameters

    Returns void

  • Handle drag leave operation

    Method

    dragLeave

    Parameters

    Returns void

  • Handle drag over operation

    Method

    dragOver

    Parameters

    Returns void

  • Handle drop operation

    Method

    drop

    Parameters

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Filters dataSource based on given criteria (used when searching/filtering items within, e.g. via search bar)

    Method

    filterSource

    Parameters

    • phrase: any

      string phrase to filter

    Returns void

    String message or object with detailed data

  • Undocumented

    Parameters

    • element: HTMLElement
    • newState: any

    Returns boolean

  • Undocumented

    Parameters

    Returns void

  • Undocumented

    Parameters

    • newFocusState: any

    Returns void

  • Format status text in this callback, when using object with detailed data.

    Method

    formatStatus

    Parameters

    • data: any

    Returns string

    String message or object with detailed data

  • Undocumented

    Parameters

    • evt: any

    Returns any

  • Undocumented

    Returns any

  • Undocumented

    Returns string

  • Undocumented

    Returns HTMLElement

  • Returns the first ancestor in the HTML DOM tree, that has controlClass and data-id. Searching is stopped on topParentCtrl, if defined.

    Method

    getParentControl

    Parameters

    • topParentCtrl: any

      ControlClass of the top parent, where to stop searching.

    Returns Control

    Parent Control or undefined if there's no parent.

  • Undocumented

    Returns string

  • Returns control to decide which subcontrols should be stored e.g. Multiview component overrides this as it stores states only for the active control/view

    Method

    getPersistentStateRootControl

    Returns HTMLElement

    control

  • Returns root key string under which the values are stored in persistent.JSON file on the disk.

    Method

    getPersistentStateRootKey

    Returns string

    store key id

  • Undocumented

    Returns any

  • Undocumented

    Returns any

  • Undocumented

    Parameters

    • evt: any

    Returns void

  • Undocumented

    Parameters

    • rootelem: any
    • params: any

    Returns void

  • Undocumented

    Returns boolean

  • This method is pretty similar as app.listen(), but app.unlisten() is called automatically in Control.cleanUp()

    Method

    localListen

    Parameters

    • object: any

      Object where to set listener

    • event: string

      Event of the listener

    • func: AnyCallback

      Method for callback dispatch

    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • This method is supposed to automatically cancel running promises when component is going to destroy.

    Method

    localPromise

    Parameters

    • promise: any

    Returns any

  • Undocumented

    Parameters

    Returns boolean

  • Control is allow drag object

    Method

    makeDraggable

    Parameters

    • element: any
    • Optional canBeDragged: boolean

    Returns void

  • Undocumented

    Parameters

    • el: any

    Returns void

  • Undocumented

    Parameters

    • nodeDataSource: any
    • nodeHandlerID: any
    • clickedArea: any
    • Optional newTab: boolean

    Returns void

  • Undocumented

    Parameters

    • id: string

    Returns any

  • Raise the event on the Control

    Example

    if (!this.raiseEvent('selecting', {
    tabIndex: value,
    oldTabIndex: oldSelected
    }, true))
    return; // canceled, do not change selection

    Parameters

    • eventName: any

      Name of the event

    • Optional details: AnyDict

      Custom parameters to be sent with the event

    • Optional isCancelable: boolean

      Whether the event can be canceled.

    • Optional canBubble: boolean

      Whether the event can bubble.

    • Optional sender: EventTarget

      of the event. Container by default.

    Returns boolean

    Success. If 'false', the event was canceled.

  • Undocumented

    Parameters

    • event: any
    • Optional capture: boolean

    Returns void

  • Undocumented

    Parameters

    • source: any

    Returns void

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.

    Example

    this.requestFrame(function () {
    // this callback will be executed at a maximum of your monitor's natural refresh rate.
    }, "myUniqueFrameCallbackName");

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • 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.

    Example

    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");

    Method

    requestFrameMM

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestIdle

    Parameters

    • callback: any

      Callback, which should be called when idle

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestTimeout

    Parameters

    • callback: (() => void)

      Callback, which should be called after timeout

        • (): void
        • Returns void

    • timeMS: number

      Timeout, in ms

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Undocumented

    Parameters

    • state: any

    Returns void

  • Restores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    restorePersistentStates

    Returns void

  • Undocumented

    Parameters

    • state: any

    Returns void

  • Undocumented

    Parameters

    • taskid: any

    Returns void

  • Undocumented

    Parameters

    • message: any

    Returns void

  • Undocumented

    Parameters

    • el: any
    • val: any
    • effectiveVal: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • value: any

    Returns void

  • Set details for dragged element

    Method

    setDragElementData

    Parameters

    • element: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • en: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • idx: number

    Returns void

  • Undocumented

    Parameters

    • idx: number

    Returns void

  • Set status text. Can be simple string or object with data formatted later in formatStatus method.

    Method

    setStatus

    Parameters

    • data: any

    Returns void

    String message or object with detailed data

  • Undocumented

    Parameters

    • lang: any
    • Optional pgObj: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns {
        bigHeader: boolean;
    }

    • bigHeader: boolean

      Undocumented

  • Stores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    storePersistentStates

    Returns void

  • Method for handling Promise with delayed progress.

    Method

    thenWithProgress

    Parameters

    • pPromise: any

      Passed promise

    • Optional params: any

      Object with possible parameters:

      • thenFunc - function called after resolving promise
      • errorFunc - function called after rejecting promise
      • delayedFunc - function called after given delay
      • delayMS - progress delay, default 100ms. Progress is displayed after this time, in case promise was not resolved yet
      • progressText - text displayed in delayed progress, default string is "Getting data"
      • progress - SimpleTasksController object, used for progress. If not present, use global progress.

    Returns void

  • Undocumented

    Parameters

    • event: string
    • Optional capture: boolean

    Returns void

  • Undocumented

    Parameters

    • source: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void