Module: alfresco/documentlibrary/views/AlfFilmStripView

alfresco/documentlibrary/views/AlfFilmStripView

This module provides a view intended for use in Document Lists and allows users to quickly scan through previews of documents without needing to go to a specific page.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

arrows :object

This property can be used to customise the arrows used in the carousels. The four properties (contentPrev, contentNext, listPrev, listNext) correspond to the previous and next arrows in the content carousel and the item-list carousel respectively.

The value of each property should correspond to the properties of an Image widget, which should be used as a reference of available properties.

NOTE: All defaults are as they are in the Image widget, apart from srcType which instead defaults to FULL_PATH.

Type:
  • object
Properties:
Name Type Argument Description
contentPrev object <optional>
 The replacement Image config for the previous-arrow in the content carousel
contentNext object <optional>
 The replacement Image config for the next-arrow in the content carousel
listPrev object <optional>
 The replacement Image config for the previous-arrow in the item-list carousel
listNext object <optional>
 The replacement Image config for the next-arrow in the item-list carousel
Since:
  • 1.0.41
Default Value:
  • null
Source:
See:

cssRequirements :object[]

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

heightAdjustment :number

This is used to set the heightAdjustment of the AlfFilmStripViewDocument that is rendered by default.
Type:
  • number
Since:
  • 1.0.41
Default Value:
  • 0
Source:

heightMode :string

This is used to set the heightMode of the AlfFilmStripViewDocument that is rendered by default.
Type:
  • string
Since:
  • 1.0.41
Default Value:
  • "AUTO"
Source:

itemCarouselHeight :number

The height in pixels to make the item carousel. This can be configured to adjust the size of the thumbnails that are displayed.
Type:
  • number
Since:
  • 1.0.51
Default Value:
  • 112
Source:

previewerPluginOverrides :object[]

The value configured is passed to the previewerPluginOverrides which is then passed to the widgetsForPluginsOverrides of the widgetsForPluginsOverrides that is rendered by default. Configuring or overriding widgetsForContent can potentially change this depending upon the change made.
Type:
  • object[]
Since:
  • 1.0.51
Default Value:
  • null
Source:

renderFilterSelectorQuery :string

Override the default selector to match items in the FilmStrip view. This is required because the view doesn't render table rows.
Type:
  • string
Default Value:
  • "div.items ol li"
Source:

templateString :String

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

viewSelectionConfig :object

The configuration for selecting the view (configured the menu item)
Type:
  • object
Properties:
Name Type Description
label string | null The label or message key for the view (as appears in the menus)
iconClass string | null The class to place next to the label
Source:

widgets :object[]

The definition of how a single item is represented in the view.
Type:
  • object[]
Source:

widgetsForContent :object[]

The definition of how a single item is represented the preview.
Type:
  • object[]
Source:

Methods

createListRenderer() → {object}

Creates a new ListRenderer which is used to render the actual items in the view. This function can be overridden by extending views (such as the Film Strip View) to create alternative widgets applicable to that view.
Source:
Returns:
A new ListRenderer
Type
object

destroyRenderer()

Extends the inherited function to destroy the content carousel.
Since:
  • 1.0.32
Source:

getViewName() → {string}

Returns the name of the view that is used when saving user view preferences.
Source:
Returns:
"detailed"
Type
string

onViewShown()

Extends the inherited function to ensure that both carousels are sized appropriately after being added into the view.
Source:

renderView(preserveCurrentData)

Extends the inherited function to publish a request to get the details of the first item (if available). This request is intended to be serviced by the DocumentService and the published response should be picked up the AlfDocument to render the preview as appropriate
Parameters:
Name Type Description
preserveCurrentData boolean
Source: