Module: alfresco/documentlibrary/_AlfDocumentListTopicMixin

alfresco/documentlibrary/_AlfDocumentListTopicMixin

This module simply provides a set of attributes that define topic names for publications and subscriptions. This should be mixed into any widget that wishes to use those topics to ensure consistency. It also allows the actual values to be managed from a single file.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Members

docListTagChangedTopic :string

This is fired when a tag is chosen for a document list.
Type:
  • string
Default Value:
  • topics.DOCUMENTLIST_TAG_CHANGED
Source:

pathChangeTopic :string

This topic should be published to indicate that a path has been changed. It is used by both the AlfDocumentList and the AlfBreadcrumbTrail, but the default value can be overridden through configuration if required.
Type:
  • string
Default Value:
Source:

Events

documentDeselectedTopic

Use to indicate that an individual document has been deselected (e.g. that it should no longer be included in group actions).
Type:
  • string
Properties:
Name Type Description
value object The item de-selected
Source:

documentSelectedTopic

This differs from the "documentSelectionTopic" attribute as it should be used for individual documents
Type:
  • string
Properties:
Name Type Description
value object The item selected
Source:

documentSelectionTopic

This differs from the "documentSelectedTopic" attribute as it is used to make general selection requests, e.g. "selectAll"
Type:
  • string
Properties:
Name Type Description
selectedItems object[] The selected items
Default Value:
  • DOCUMENT_SELECTION_UPDATE
Source:
Listeners of This Event:

documentTaggedTopic

Used to indicate that a document has been tagged.
Type:
  • string
Default Value:
  • topics.DOCUMENT_TAGGED
Source:
Listens to Events:
Listeners of This Event:

selectedDocumentsChangeTopic

Used to indicate the list of currently selected documents has changed and provides the details of those items.
Type:
  • string
Properties:
Name Type Description
selectedItems object[] The items selected
Source:

sortFieldSelectionTopic

Type:
  • string
Default Value:
  • UPDATE_LIST_SORT_FIELD
Source: