Module: alfresco/lists/views/layouts/HeaderCell

alfresco/lists/views/layouts/HeaderCell

Author:
  • Dave Draper
License:
Source:

Members

a11yScope :string

Optional accessibility scope.
Type:
  • string
Default Value:
  • null
Source:

cssRequirements :object[]

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

i18nRequirements :object[]

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

sortable :boolean

Indicates whether or not this header can actually be used to trigger sort requests.
Type:
  • boolean
Default Value:
  • false
Source:

sortAscAlt :string

Optional alt text for the sort ascending icon. An optional {0} token can be provided to insert the label
Type:
  • string
Default Value:
  • null
Source:

sortDescAlt :string

Optional alt text for the sort descending icon. An optional {0} token can be provided to insert the label.
Type:
  • string
Default Value:
  • null
Source:

sortedAscending :boolean

Indicates whether or not the column headed by this cell is sorted in ascending order or not. This value is only relevant when the usedForSort attribute is true.
Type:
  • boolean
Default Value:
  • false
Source:

sortValue :string

The value to publish to sort on.
Type:
  • string
Default Value:
  • null
Source:

toolTipMsg :string

The tool tip to display.
Type:
  • string
Default Value:
  • null
Source:

transparentImageUrl :string

A transparent image to use (this will allow the background image to show through).
Type:
  • string
Since:
  • 1.0.77
Default Value:
  • null
Source:

usedForSort :boolean

Indicate whether or not this cell is currently being used as the sort field.
Type:
  • boolean
Default Value:
  • false
Source:

useHash :boolean

Indicates whether or not the current browser URL hash should be used to determine whether or not the header is currently marked as being sorted.
Type:
  • boolean
Since:
  • 1.0.56
Default Value:
  • false
Source:

Methods

addA11yScope()

Adds a scope attribute to the header cell if provided.
Source:

createWidgetDom()

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

focus()

Focuses the domNode. This has been added to support the dijit/_KeyNavContainer functions mixed into the document library views to allow easier keyboard navigation.
Source:

onExternalSortRequest(payload)

This handles external sort requests so that the header cell can match the current status.
Parameters:
Name Type Description
payload object
Source:

onSortClick(evt)

This function is called whenever the header cell is clicked. It publishes a request to resort the current data and updates its display
Parameters:
Name Type Description
evt object The click event
Source:

postCreate()

Calls processWidgets
Source:
Listens to Events:
  • module:alfresco/lists/views/layouts/HeaderCell#event:sortRequestTopic
  • module:alfresco/lists/views/layouts/HeaderCell#event:sortFieldSelectionTopic

postMixInProperties()

Source:

publishSortRequest()

Source:
Fires:
  • module:alfresco/lists/views/layouts/HeaderCell#event:sortRequestTopic

sortIcon(dir)

This controls the display of icons when using sort functionality.
Parameters:
Name Type Description
dir string asc, desc or nil
Source: