Module: alfresco/forms/controls/SelectedListItems

alfresco/forms/controls/SelectedListItems

This form control uses a list as its wrapped widget and uses the currently selected items as its value. This relies on the view defined by the configured widget model to contain [selectors]{@link module:alfresco/renderers/Selector} (or some other renderer that inherits from ItemSelectionMixin) in order for the selected item state to be both updated and represented.
Since:
  • 1.0.59
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

widgetsForList :object[]

This should be configured to be the model rendered as the wrapped widget. It is expected to be an array containing a single object element defining a list (or one of its descendents).
Type:
  • object[]
Default Value:
  • null
Source:

Methods

createFormControl()

Create the form control using the widgetsForList configuration.
Source:
Listens to Events:
  • module:alfresco/core/topics#event:REQUEST_FINISHED_TOPIC

getValue() → {boolean}

Gets the items that have been selected in the list.
Source:
Returns:
The items selected in the list
Type
boolean

getWidgetConfig()

Source:

selectItemsInList()

This is called from setValue when a request is made to update the selected items and the list has been rendered. The array of values is converted into a map which is assigned to previouslySelectedItems and then retainPreviousItemSelectionState is called.
Source:

setupChangeEvents()

Overrides the inherited function to listen to watch for changes to the selected items in the list.
Source:
Listens to Events:
  • module:alfresco/core/topics#event:DOCUMENT_SELECTED

setValue(value)

Sets the selected items in the list.
Parameters:
Name Type Description
value object The value to set.
Source: