Module: alfresco/layout/TitleDescriptionAndContent

alfresco/layout/TitleDescriptionAndContent

This is a simple layout structure that allows for a title and description to be specified as properties and for the configured widgets to be placed underneath.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

cssRequirements :object[]

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

description :string

The description to be rendered.
Type:
  • string
Source:

itemKeyProperty :string

This is the property that is used to uniquely identify the item that this widget is being used to provide a title for. It is used to ensure that the any publications made on the subscriptionTopic relate to the current instance.
Type:
  • string
Since:
  • 1.0.85
Default Value:
  • "nodeRef"
Source:

subscribeGlobal :boolean

Indicates whether the subscriptionTopic should be subscribed to globally.
Type:
  • boolean
Since:
  • 1.0.85
Default Value:
  • false
Source:

subscriptionTopic :string

A topic to subscribe to that when published can update the title and description shown.
Type:
  • string
Since:
  • 1.0.85
Default Value:
  • null
Source:

templateString :string

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

title :string

The title to be rendered
Type:
  • string
Source:

Methods

postCreate()

Processes the widgets into the content node.
Source:

postMixInProperties()

Ensures that the title and description are converted from key to localised message.
Source:

setTitleAndDescription(title, description)

Updates the title and description
Parameters:
Name Type Description
title string The title to set
description string The description to set
Since:
  • 1.0.85
Source:

update(payload)

Parameters:
Name Type Description
payload object The payload containing the details to update
Source: