Module: alfresco/renderers/PublishingDropDownMenu

alfresco/renderers/PublishingDropDownMenu

This renders a drop-down select menu using a wrapped Select widget that when changed will publish information about the change in value for the current rendered item.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

_dropDownWidget :object

This will be set to reference the Select that is wrapped by this widget.
Type:
  • object
Default Value:
  • null
Source:

cancelPublishLabel :String

Optional override for the title text to be displayed when hovering over the cancel "button"
Type:
  • String
Source:

cssRequirements :object[]

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

disablementProperty :string

This is the dot-property that will be evaluated on the current item being rendered to determine whether or not the wrapped select widget should be disabled. The value of the evaluated property is expected to be a boolean (or it will be evalutated as a "truthy"/"falsy" value, e.g. 0 would be false and 1 would be true, the empty string false, any other string true, etc).
Type:
  • string
Since:
  • 1.0.35
Default Value:
  • null
Source:

i18nRequirements :Array

An array of the i18n files to use with this widget.
Type:
  • Array
Source:

optionsConfig :object

This is the options config that will be passed onto the wrapped DojoSelect widget.
Type:
  • object
Default Value:
  • null
Source:

publishTopic :string

This is the topic that will be published on when the drop-down menu value is changed.
Type:
  • string
Default Value:
  • null
Source:

Methods

createWidgetDom()

Overrides the inherited function to construct the DOM for the widget using native browser capabilities.
Since:
  • 1.0.101
Source:

onChangeFailure(payload)

This function is called whenever the request to update the value fails. It will hide the processing image and display the warning image. TODO: Ideally this should include a popup failure message TODO: The CoreXhr standard failure dialog should be prevented from being displayed
Parameters:
Name Type Description
payload object
Source:

onChangeSuccess(payload)

This function is called whenever the request to update the value is completed successfully. It will hide the processing image and display the success image.
Parameters:
Name Type Description
payload object
Source:

onPublishChange(payload)

Parameters:
Name Type Description
payload object The information about the change in value.
Source:

postCreate()

Source:

<inner> onChangeCancel()

This function is called whenever the request to update the value is cancelled. It hides the processing image and doesn't display anything else.
Source: