Class ecm.widget.listView.modules.Breadcrumb


Extends ecm.widget.listView.modules._Module.
This content list module provides breadcrumb capability. It uses the resultSet's parentFolder or searchTemplate to get the start of the path. It then traverses the whole path using the parent on the item or search template. If the breadcrumb is clicked, it calls contentList openItem.
Defined in: <ecm\widget\listView\modules\Breadcrumb.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 

Field Summary

Field Attributes Field Name and Description
 
Boolean indicating if the breadcrumb should be disabled (i.e.
 
Boolean indicating if the root item name should be included.
 
Optional root preview to display.

Method Summary

Method Attributes Method Name and Description
 
Destroy the widget.
 
See GridX API documentation for details.
 
Returns the button area dom node that the buttons are contained in.
 
hasItem(item)
Returns a boolean indicating if the input item is in the breadcrumb.
 
Preload listens to events and sets the breadcrumb.

Constructor Detail

ecm.widget.listView.modules.Breadcrumb()

Field Detail

disabled

Boolean indicating if the breadcrumb should be disabled (i.e. not clickable).

includeRootItemName

Boolean indicating if the root item name should be included.

rootPrefix

Optional root preview to display.

Method Detail

destroy()

Destroy the widget.

getAPIPath()

See GridX API documentation for details.

getBreadcrumb()

Returns the button area dom node that the buttons are contained in.

hasItem(item)

Returns a boolean indicating if the input item is in the breadcrumb.
Parameters:
item
Since:
2.0.3

preload()

Preload listens to events and sets the breadcrumb.