Module: alfresco/documentlibrary/ViewPreferencesGroup

alfresco/documentlibrary/ViewPreferencesGroup

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

Extends

Members

i18nRequirements :object[]

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

label :string

[label description]
Type:
  • string
Default Value:
  • "documentlibrary.view.preference.group"
Source:

userIsSiteManager :boolean

Indicates whether or not the current user is a site manager (only relevant when looking at a Document Library within a site context). Assumed to be false unless configured otherwise.
Type:
  • boolean
Default Value:
  • false
Source:

userPreferredView :string

The users preferred view.
Type:
  • string
Default Value:
  • null
Source:

widgets :array

Type:
  • array
Source:

Methods

handleCurrentNodeChange(payload)

Parameters:
Name Type Description
payload object The details of the node that is now current.
Source:

onViewName(updateMenuItem, view)

This function is called when a preferred view confirms it's existence by resolving a promimse provided. This then allows that view to be set.
Parameters:
Name Type Description
updateMenuItem boolean Indicates whether or not the menu item for removing the view should be updated
view object The view configuration
Source:

onViewSelected(payload)

Used to keep track of the currently selected view.
Parameters:
Name Type Description
payload object The payload object containing the details of the view selected
Source:

postCreate()

Extends the inherited function to setup subscriptions to the topics published as views and paths are changed within the document list.
Source:

updateMenus()

Updates the menu items for setting and removing default views
Source:

updateViews()

Publishes payload to update the currently selected view based on the default view of the current node and the preferred view of the user.
Source: