Module: alfresco/creation/WidgetConfig

alfresco/creation/WidgetConfig

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

Extends

Mixes In

Members

clearTopic :string

Can be used to clear the currently displayed widget.
Type:
  • string
Default Value:
  • "ALF_CLEAR_CONFIGURE_WIDGET"
Source:

configTopic :string

This will need to be prefixed with a scope.
Type:
  • string
Default Value:
  • "ALF_CONFIGURE_WIDGET"
Source:

cssRequirements :Array

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

currentWidgetConfig

The configuration for the currently displayed widget.
Default Value:
  • null
Source:

i18nRequirements :Array

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

saveTopic :string

Can be used to clear the currently displayed widget.
Type:
  • string
Default Value:
  • "ALF_SAVE_CONFIGURE_WIDGET"
Source:

templateString :String

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

Methods

allWidgetsProcessed(widgets)

Parameters:
Name Type Description
widgets object[] The widgets that have been created.
Source:

clearCurrentDisplay()

Clears the currently displayed widget configuration.
Source:

destroyOldConfigWidget(The, The)

Simply calls destroyRecursive on the supplied widget, but abstracted to it's own function for the purposes of extensibility.
Parameters:
Name Type Description
The object widget to destroy
The number index of the widget in the config panel
Source:

displayWidgetConfig()

This function is called whenever a new widget is selected that requires configuration.
Source:

postCreate()

Source:

saveWidgetConfig()

Handler for the save button that published the updated configuration for a widget so that it can be re-rendered.
Source: