Module: alfresco/layout/StickyPanel

alfresco/layout/StickyPanel

This widget is used by the NotificationService to display a sticky panel attached to the bottom of the screen. It should not be instantiated directly.

NOTE: There is a bug with older browsers (IE8/IE9/IE10 only) that means that it is not possible to click on elements to the left or right of the sticky panel.

Since:
  • 1.0.48
Author:
  • Martin Doyle
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

baseClass :string

The main class for this widget
Type:
  • string
Default Value:
  • "alfresco-layout-StickyPanel"
Source:

closeButtonLabel :string

The label to display on the minimise button for accessibility reasons
Type:
  • string
Since:
  • 1.0.58
Default Value:
  • "button.close.label"
Source:

cssRequirements :object[]

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

i18nRequirements :object[]

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

minimiseButtonLabel :string

The label to display on the minimise button for accessibility reasons
Type:
  • string
Since:
  • 1.0.58
Default Value:
  • "button.minimise.label"
Source:

panelWidth :string|number

The width of the panel. Can be provided as a CSS dimension (e.g. 50%, 100px) or a pure number, which will be treated as pixels.
Type:
  • string | number
Default Value:
  • "50%"
Source:

restoreButtonLabel :string

The label to display on the minimise button for accessibility reasons
Type:
  • string
Since:
  • 1.0.58
Default Value:
  • "button.restore.label"
Source:

templateString :string

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

title :string

The title to display in the title-bar of the panel
Type:
  • string
Default Value:
  • "default.title"
Source:

widgets :object[]

The widgets to display inside the panel
Type:
  • object[]
Default Value:
  • null
Source:

widgetsPadding :number

The padding to apply around the widgets, in pixels.
Type:
  • number
Default Value:
  • 10
Source:

Methods

_setTitleAttr(newTitle)

Prevent the title property from being used to set the title attribute on the widget's root node.
Parameters:
Name Type Description
newTitle string The new title
Since:
  • 1.0.55
Source:

close()

Close the panel.
Source:
Fires:

disableCloseButton(payload)

Disables the close button.
Parameters:
Name Type Description
payload object Payload for the publication (expected to be empty)
Since:
  • 1.0.54
Source:

enableCloseButton(payload)

Enables the close button.
Parameters:
Name Type Description
payload object Payload for the publication (expected to be empty)
Since:
  • 1.0.54
Source:

onClickClose()

Handle clicks on the close button (unless it has been disabled).
Source:

onClickMinimise()

Handle clicks on the minimise or restore buttons.
Since:
  • 1.0.58
Source:

onClickRestore()

Handle clicks on the minimise or restore buttons.
Since:
  • 1.0.58
Source:

postCreate()

Run after widget created, but before sub-widgets.
Source:

postMixInProperties()

Mix in properties after instance created.
Source:

setMinimised(minimise)

Set the minimised state
Parameters:
Name Type Description
minimise boolean Whether to minimise the panel (true will minimise, false will restore)
Since:
  • 1.0.58
Source:

setTitle(payload)

Set the title of the panel. If no payload or title is provided, then it will use the title property.
Parameters:
Name Type Description
payload object The payload containing the new title
Properties
Name Type Description
title string The new title
Source:

setupSubscriptions()

Setup all of the subscriptions.
Source:
Listens to Events:

sizePanel()

Size the panel, based on the panelWidth property. If we receive a number without units (apart from 0), we should assume it's pixels.
Source: