Module: alfresco/pickers/PropertyPicker

alfresco/pickers/PropertyPicker

This extends the standard document list to define a document list specifically for selecting properties. 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

dataFailureMessage :string

This is the message to display when data cannot be loaded Message keys will be localized where possible.
Type:
  • string
Default Value:
  • "propPicker.data.failure.message"
Source:

fetchingDataMessage :string

This is the message to display when data is loading. Message keys will be localized where possible.
Type:
  • string
Default Value:
  • "propPicker.loading.data.message"
Source:

fetchingMoreDataMessage :string

This is the message to display when fetching more data. Message keys will be localized where possible.
Type:
  • string
Default Value:
  • "propPicker.loading.data.message"
Source:

i18nRequirements :object[]

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

noDataMessage :string

This is the message to display when no data is available. Message keys will be localized where possible.
Type:
  • string
Default Value:
  • "propPicker.no.data.message"
Source:

publishPickedItemsToParent :boolean

This attribute has been added to support the scenario where properties can be selected from either a global list or from a sub-picker that narrows them down to either aspect or type. It is required because a sub-picker needs to publish to the parent but the primary picker doesn't. This is used by the PropertyPicker form control when defining the picker configuration.
Type:
  • boolean
Default Value:
  • false
Source:

renderingViewMessage :string

This is the message to display whilst a view is being rendered. Message keys will be localized where possible.
Type:
  • string
Default Value:
  • "propPicker.rendering.data.message"
Source:

useHash :boolean

Indicates whether the location should be driven by changes to the browser URL hash
Type:
  • boolean
Default Value:
  • false
Source:

waitForPageWidgets :boolean

Override the inherited value because this widget is typically created after the page has loaded.
Type:
  • boolean
Default Value:
  • false
Source:

widgets :object

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

Methods

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)

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:

postCreate()

Overrides the inherited function to update the publishToParent attribute of the PublishAction widget defined in the widgets attribute to use the configured publishPickedItemsToParent value.
Source: