Module: alfresco/documentlibrary/AlfDocumentList

alfresco/documentlibrary/AlfDocumentList

Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

currentFilter :object

Type:
  • object
Default Value:
  • null
Source:

folderClickPublishGlobal :boolean

This indicates whether or not clicking on a folder will perform a globally scoped publication. This is true by default as the as the default topic for folder clicks is expected to be subscribed to by the NavigationService which will typically be subscribing globally.
Type:
  • boolean
Default Value:
  • true
Source:

i18nRequirements :object[]

An array of the i18n files to use with this widget.
Type:
  • object[]
Default Value:
  • [{i18nFile: "./i18n/AlfDocumentList.properties"}]
Source:

linkClickTopic :string

This is the topic that will be subscribed to for responding to item clicks unless useHash is set to true. [Views]{@link module:alfresco/lists/views/AlfListView} that defined renderers that provide links using the _ItemLinkMixin should be configured to set a matching _ItemLinkMixin attribute in order to have their actions processed.
Type:
  • string
Default Value:
  • "ALF_DOCLIST_NAV"
Source:

parentNavTopic :String

Used to trigger an event to navigate up a directory.
Type:
  • String
Default Value:
  • "ALF_DOCLIST_PARENT_NAV"
Source:

rawData :boolean

Set this attribute to be true if the Document List should retrieve data directly from the Alfresco repository rather than going through an intermediary client REST API. For example the DocumentService will request data from a Share REST API rather than going directly to the repository.
Type:
  • boolean
Default Value:
  • false
Source:

showDocuments :boolean

Indicates whether or not documents should be shown in the document library.
Type:
  • boolean
Default Value:
  • true
Source:

showFolders :boolean

Indicates whether or not folders should be shown in the document library.
Type:
  • boolean
Default Value:
  • true
Source:

suppressDndUploading :boolean

Overrides the default configuration to ensure that document lists support drag-and-drop uploading (unless otherwise configured).
Type:
  • boolean
Since:
  • 1.0.39
Default Value:
  • false
Source:

updateInstanceValues :boolean

Overrides the inherited default to ensure that instance values should be updated from the hash. This only appliees when useHash is configured to be true.
Type:
  • boolean
Default Value:
  • true
Source:

widgetsForFilters :object[]

Overrides the default filters as there should be no filters for document lists unless explicitly configured.
Type:
  • object[]
Since:
  • 1.0.42
Default Value:
  • null
Source:

Methods

_updateCoreHashVars(hashParameters)

Checks the hash for updates relating to pagination and sorting.
Parameters:
Name Type Description
hashParameters object An object containing the current hash parameters
Source:

copyViewData()

Extends the inherited function to set the drag-and-drop upload capabilities based on the currentFilter value. If the filter has a path value then addUploadDragAndDrop is called, otherwise removeUploadDragAndDrop is called.
Since:
  • 1.0.51
Source:

onCategoryChanged(payload)

Handles requests to update the current category.
Parameters:
Name Type Description
payload object The details of the new category path
Source:
Fires:
  • event:ALF_NAVIGATE_TO_PAGE

onDocumentClick(payload)

Parameters:
Name Type Description
payload object
Source:

onDocumentSelection(payload)

Parameters:
Name Type Description
payload object The published details of the selected items
Source:

onFilterChanged(payload)

Parameters:
Name Type Description
payload object The details of the changed filter
Source:
Fires:
  • event:ALF_NAVIGATE_TO_PAGE

onFolderClick(payload)

Parameters:
Name Type Description
payload object
Source:

onItemLinkClick(payload)

This function is called whenever the [linkClickTopic]linkClickTopic is published. It processes the payload and updates the current filter and then refreshes the current data by calling loadData.
Parameters:
Name Type Description
payload object
Source:

onPathChanged(payload)

Handles requests to update the current path.
Parameters:
Name Type Description
payload object The details of the new path
Source:
Fires:
  • event:ALF_NAVIGATE_TO_PAGE

onShowFolders(payload)

Parameters:
Name Type Description
payload object The details of the request
Source:

onTagChanged(payload)

Parameters:
Name Type Description
payload object The details of the changed tag
Source:
Fires:
  • event:ALF_NAVIGATE_TO_PAGE

postCreate()

Run after widget created
Since:
  • 1.0.48
Source:

postMixInProperties()

Extends the inherited function to set a default filter to be a root path.
Source:

processLoadedData(response)

This is an extension point function for extending modules to perform processing on the loaded data once it's existence has been verified
Parameters:
Name Type Description
response object The original response.
Source:

setupSubscriptions()

This function sets up the subscriptions that the Document List relies upon to manage its internal state and request documents.
Source:
Listens to Events:

updateLoadDataPayload(payload)

Extends the inherited function to add the additional document library related data.
Parameters:
Name Type Description
payload object The payload object to update
Source:

<inner> onParentNav(payload)

Triggered when a request to navigate to the current items parent is shown. If the currentFilter is a non-root path then it will be updated to remove the last element of the current path. In all other cases a publication will be made requesting the retrieval of the parent node.
Parameters:
Name Type Description
payload
Source:
Fires:
  • event:ALF_DOC_GET_PARENT_NODEREF

<inner> onParentNavSuccess(payload)

Triggered when we have the parent node object. (call back from onParentNav)
Parameters:
Name Type Description
payload
Source: