Module: alfresco/pickers/DocumentListPicker

alfresco/pickers/DocumentListPicker

This extends the standard document list to define a document list specifically for selecting documents (e.g. for starting workflows, etc). It was written to be used as part of a picker and specifically one that is used as a form control.

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

Extends

Members

publishPayload :object

This is the configured payload published when a document is picked. By default it is null
Type:
  • object
Default Value:
  • null
Source:

publishPayloadItemMixin :boolean

This indicates whether the current item should be mixed into the published payload. By default this is false (because the default type is to just publish the current item)
Type:
  • boolean
Default Value:
  • false
Source:

publishPayloadModifiers :array

The modifiers to apply to the publish payload. This should only be set if the publishPayloadType is set to "PROCESS".
Type:
  • array
Default Value:
  • null
Source:

publishPayloadType :string

This is the type of payload published when a document is picked. By default it is the current item type.
Type:
  • string
Default Value:
  • "CURRENT_ITEM"
Source:

publishTopic :string

This topic that is published when a document is picked. By default it is the topic that indicates that the document has been selected.
Type:
  • string
Default Value:
  • "ALF_ITEM_SELECTED"
Source:

rootNodeRef :String

This nodeRefRef is used to limit navigation up the directory, to constrain the picker to the a certain path. It can be passed in on config, but if not, it will be set the first time loadData is called.
Type:
  • String
Default Value:
  • null
Source:

siteMode :Boolean

Enable site mode. In site mode the peer folders of the documentlibrary container are hidden and we skip straight to documentlibrary's children
Type:
  • Boolean
Default Value:
  • false
Source:

useHash :boolean

Overrides the inherited value to indicate that the location should not be driven by changes to the browser URL hash
Type:
  • boolean
Default Value:
  • false
Source:

waitForPageWidgets :boolean

Overrides the inherited value to ensure that pickers don't wait for the page to be loaded (as typically the page will be loaded long before the picker is opened). This can still be overridden again in configuration when creating a new picker.
Type:
  • boolean
Default Value:
  • false
Source:

widgets :array

The default widgets for the picker. This can be overridden at instantiation based on what is required to be displayed in the picker.
Type:
  • array
Source:

Methods

loadData()

Extends loadData to store the rootNodeRef.
Source:

onDataLoadSuccess(payload)

Overrides onDataLoadSuccess to skip children.
Parameters:
Name Type Description
payload object
Source:

onDocumentClick(payload)

Overrides inherited function to do a no-op. The pick action should be handled by a PublishAction widget.
Parameters:
Name Type Description
payload object
Source:

onFolderClick(payload)

Override the default implementation to call loadData with the currently selected folder node.
Parameters:
Name Type Description
payload object
Source:
To Do:
  • Refactor this code to accept the same payload format as module:alfresco/documentlibrary/AlfDocumentList#onItemClick

postCreate()

Overrides the inherited function to create the picker view for selecting documents.
Source: