Module: alfresco/lists/views/_AlfAdditionalViewControlMixin

alfresco/lists/views/_AlfAdditionalViewControlMixin

This mixin provides display filtering capabilities. It can be mixed into any widget so that if the widget is configured with a filterTopic that the control is associated with. This is used as a comparison in the [filter]module:alfresco/lists/views/_AlfAdditionalViewControlMixin#filter function.
Type:
  • string
Default Value:
  • null
Source:

Methods

filter(payload)

Overrides the [superclass implmentation]{@link module:alfresco/menus/AlfDisplayFilterMixin#filter} to check the published view against the configured view to determine whether or not to display the control.
Parameters:
Name Type Description
payload object The payload published on the filter topic
Source:

onControlDisplayed()

This is called each time the view that the control is assigned to is selected. By default it does nothing and needs to be overridden as necessary by the widget that mixes this class in.
Source:

postMixInProperties()

Sets the filterTopic attribute to be the [viewSelectionTopic]{@link module:alfresco/documentlibrary/_AlfDocumentListTopicMixin#viewSelectionTopic} so that when a view is changed the [filter]{@link module:alfresco/lists/views/_AlfAdditionalViewControlMixin#filter} function is called.
Source: