Module: alfresco/lists/ResultsPerPageGroup

alfresco/lists/ResultsPerPageGroup

A specialization of AlfMenuGroup to define widget configuration for selecting the number of results to per page in a document list.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

documentsPerPage

Default Value:
  • 25
Source:

groupName :string

The name of the group to assign to each of the AlfCheckableMenuItems that are created. If this widget is used more than once on any given page it is important to assign each instance a different group as all the menu items in both widgets will share the same group and only one will ever be selected across both groups.
Type:
  • string
Default Value:
  • "DOCUMENTS_PER_PAGE_GROUP"
Source:

i18nRequirements :object[]

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

Methods

onDocumentsPerPageChange(payload)

Handles updates to the number of documents to display per page.
Parameters:
Name Type Description
payload object
Source:

postCreate()

Source:

postMixInProperties()

Source:
Fires:
  • event:getPreferenceTopic
Listens to Events:

setDocumentsPerPage(value)

Sets the number of documents per page
Parameters:
Name Type Description
value number The number of documents per page.
Source: