Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContentList

Component that lets you display and work with a simple Content Collection

Usage example:

<content-list scope.bind="Scope"
     get-items.call="GetSelectedChildren(scope, query)"
     on-activate.call="Select(content)"
     on-drop-files.call="FilesDropped(event, files)"
     on-drop-content.call="ContentDropped(content)"
     on-drop-content-list.call="ContentListDropped(contentList)"
     on-drop-content-on-item.call="ContentDroppedOnItem(content, item)"
     on-drop-content-list-on-item.call="ContentListDroppedOnItem(contentList, item)"
     view-type.bind="ViewType"
     query.bind='query'
     selection.two-way="SelectedContent"
     on-action.call="onAction(content, action)"></content-list>

Hierarchy

  • ContentList

Index

Constructors

constructor

  • new ContentList(repository: Repository, bindingSignaler: BindingSignaler): ContentList

Properties

Private bindingSignaler

bindingSignaler: BindingSignaler

enableSelection

enableSelection: boolean = true

Private eventHub

eventHub: EventHub

getItems

getItems: function

Type declaration

    • (params: object): Promise<IContent[]>
    • Parameters

      • params: object
        • Optional query?: Query<IContent>
        • scope: IContent

      Returns Promise<IContent[]>

isLoading

isLoading: boolean = false

items

items: IContent[]

lastSelectionIndex

lastSelectionIndex: number

multiSelect

multiSelect: boolean = true

Private observers

observers: IDisposable[] = []

onAction

onAction: function

Type declaration

    • (params: object): void
    • Parameters

      • params: object
        • action: IActionModel
        • content: IContent

      Returns void

onActivate

onActivate: function

Type declaration

    • (params: object): void
    • Parameters

      • params: object
        • content: IContent

      Returns void

Optional query

query: Query<IContent>

Private repository

repository: Repository

scope

scope: IContent

scopeHistory

scopeHistory: IContent[] = []

selection

selection: IContent[] = []

Protected selectionChangedSignalKey

selectionChangedSignalKey: "content-list-selection-changed" = "content-list-selection-changed"

showScope

showScope: boolean = true

viewType

viewType: CollectionView = CollectionView.List

Accessors

hasParent

  • get hasParent(): boolean

hasScope

  • get hasScope(): boolean

Methods

activateItem

  • activateItem(content: IContent): void

clearSelection

  • clearSelection(): void

detached

  • detached(): void

disposeObservers

  • disposeObservers(): void

dropContent

  • dropContent(event: DragEvent, stringifiedContent: string, stringifiedContentList?: string[], files?: FileList): void
  • Parameters

    • event: DragEvent
    • stringifiedContent: string
    • Optional stringifiedContentList: string[]
    • Optional files: FileList

    Returns void

dropContentOnItem

  • dropContentOnItem(event: DragEvent, item: IContent, stringifiedContent?: undefined | string, stringifiedContentList?: string[], files?: FileList): void
  • Parameters

    • event: DragEvent
    • item: IContent
    • Optional stringifiedContent: undefined | string
    • Optional stringifiedContentList: string[]
    • Optional files: FileList

    Returns void

focusIn

  • focusIn(): void

focusOut

  • focusOut(): void

getActions

  • getActions(params: object): never[]

handleContentChanges

  • handleContentChanges(...changes: IContent[]): void

handleKeyPress

  • handleKeyPress(event: KeyboardEvent): boolean

isFocused

  • isFocused(content: IContent): boolean

isSelected

  • isSelected(content: IContent): boolean

itemsChanged

  • itemsChanged(): void

onDropContent

  • onDropContent(params: object): void

onDropContentList

  • onDropContentList(params: object): void

onDropContentListOnItem

  • onDropContentListOnItem(params: object): void

onDropContentOnItem

  • onDropContentOnItem(params: object): void

onDropFiles

  • onDropFiles(params: object): void

onDropFilesOnItem

  • onDropFilesOnItem(params: object): void

queryChanged

  • queryChanged(): void

reinitialize

  • reinitialize(): Promise<void>

reloadOnContentChange

  • reloadOnContentChange(content: IContent): true

scopeChanged

  • scopeChanged(newScope: IContent, lastScope: IContent): void

selectAll

  • selectAll(): void

selectItem

  • selectItem(event: MouseEvent, content: IContent): void

toggleSelection

  • toggleSelection(event: MouseEvent, content: IContent): void

triggerAction

  • triggerAction(event: MouseEvent, action: IActionModel, item: IContent): void

Generated using TypeDoc