Module: alfresco/documentlibrary/AlfTagFilters

alfresco/documentlibrary/AlfTagFilters

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

Extends

Mixes In

Members

containerId :string

The ID of the container to use on tag query requests (e.g. "documentlibrary"). This is the name of the folder that is being queried within a specific site. This should be provided in conjunction with siteId as an alternative to rootNode
Type:
  • string
Default Value:
  • null
Source:

currentTagFilters :object[]

Used to keep track of the current set of filter tags.
Type:
  • object[]
Default Value:
  • null
Source:

filterPrefsName :string

Type:
  • string
Default Value:
  • "docListTagFilterPref"
Source:

filterSelectionTopic :string

Overrides the mixed-in value so that a tag specific topic is published
Type:
  • string
Source:

i18nRequirements :object[]

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

paramName :string

Overrides the inherited hash parameter name to use for the filter to make it "tag"
Type:
  • string
Default Value:
  • "tag"
Source:

rootNode :string

The root node to base tag queries on. This should be provided as an alternative to siteId and containerId
Type:
  • string
Default Value:
  • null
Source:

siteId :string

The ID of the site to use on tag query requests. This should be provided in conjunction with [containerId]{@link module:alfresco/documentlibrary/AlfTagFilters#containerId} as an alternative to rootNode
Type:
  • string
Default Value:
  • null
Source:

Methods

clearAllTags()

Clears the current tags
Source:

clearTags(widget, index)

Destroys the supplied tag widget.
Parameters:
Name Type Description
widget object The widget to destroy
index number The index of the widget
Deprecated:
Source:

compareTags(tag, tagFilter, index)

Parameters:
Name Type Description
tag string The tag to check against
tagFilter object One of the existing filters to compare against
index number The index of the tag filter being compared.
Source:

createTagFilter(tagData)

Creates a new filter widget and then calls the addFilter function to add it.
Parameters:
Name Type Description
tagData Object The data to create the tag with.
Source:

onDocumentTagged(payload)

Handles documents being tagged and recreates the tags list
Parameters:
Name Type Description
payload object The publish payload
Source:

onTagQueryResults(response, originalRequestConfig)

Parameters:
Name Type Description
response object
originalRequestConfig object
Source:

postMixInProperties()

Called immediately after instantiation and before any processing
Source:
Listens to Events:

requestTags()

Request the tags for this tags list
Source:
Fires:

Events

tagQueryTopic

This topic is used to request that a node should be rated (the details should be supplied as the publication payload).
Type:
  • string
Source:
Listens to Events: