Module: alfresco/documentlibrary/AlfDocument

alfresco/documentlibrary/AlfDocument

Used to represent a list of documents.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:
To Do:
  • Clearly needs more info

Extends

Mixes In

Members

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/AlfDocumentList.css"}]
Source:

itemProperty :string

This is a dot-notation property that can be set to look up a specific location in the response. By default it is not set, and only required when not relying on the DocumentService to provide data.
Type:
  • string
Default Value:
  • null
Source:

loadDataPublishTopic :string

The topic published to request a document to display.
Type:
  • string
Default Value:
  • "ALF_RETRIEVE_SINGLE_DOCUMENT_REQUEST"
Source:

rawData :boolean

This indicates whether or not to make a request for document data directly from the Alfresco Repository or via the Share layer. When this widget is used outside of Share it will be necessary to configure this to be true.
Type:
  • boolean
Default Value:
  • false
Source:

templateString :String

The HTML template to use for the widget.
Type:
  • String
Source:

widgets :object[]

The widgets processed by AlfDocument should all be designed to work with a "currentItem" attribute.
Type:
  • object[]
Default Value:
  • null
Source:

xhrRequired :boolean

Used to indicate whether or not to force an XHR request to retrieve the full node data. Defaults to false assuming that all the data required is currently available in "currentItem".
Type:
  • boolean
Default Value:
  • false
Source:

Methods

destroyWidget(widget, index)

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

onDocumentLoaded(payload)

Parameters:
Name Type Description
payload object The details of the document that have been provided.
Source:

postCreate()

If no current item is set but a nodeRef has been provided then publish a request to get the document with that nodeRef.
Source:
Fires:
  • event:ALF_RETRIEVE_SINGLE_DOCUMENT_REQUEST

postMixInProperties()

Subscribes to the document load topic
Source:

renderDocument()

Source: