Class ecm.widget.Breadcrumb

Extends dijit._Widget.
Provides a widget that displays the position of a user in the IBM Content Navigator application.
Defined in: <ecm\widget\Breadcrumb.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.Breadcrumb()

Field Summary

Field Attributes	Field Name and Description
	breadcrumbs The list of breadcrumb items.
	stopContextMenuEvent Set value to false if you want to allow context menu events to pass through

Method Summary

Method Attributes	Method Name and Description
	clear() Clears the breadcrumb.
	destroy()
	getData() Returns the breadcrumb data as an array.
	isDisabled() Returns if the breadcrumb is disabled.
	onClick(breadcrumbUserData, evt) Event fired when clicking an item in the breadcrumb.
	onClickSeparator(breadcrumbUserData, separator, evt) Event fired when clicking on the separator to the right of an item
	onCompleteRendering() This event method is called after the properties have been rendered.
	onPop(bc) Event fired when a breadcrumb item is popped (removed from the breadcrumb list).
	pop(bc) Pops the specified breadcrumb item.
	postCreate()
	push(bc) Pushes the specified breadcrumb item onto the breadcrumb list.
	setData(breadcrumbArray) Creates a `_SimpleBreadcrumb` for each item in the array.

Constructor Detail

ecm.widget.Breadcrumb()

Field Detail

breadcrumbs

The list of breadcrumb items.

stopContextMenuEvent

Set value to false if you want to allow context menu events to pass through

Method Detail

clear()

Clears the breadcrumb.

destroy()

getData()

Returns the breadcrumb data as an array.

Returns:: Array of breadcrumb data.

isDisabled()

Returns if the breadcrumb is disabled.

Returns:: Boolean indicating if the breadcrumb is disabled.

onClick(breadcrumbUserData, evt)

Event fired when clicking an item in the breadcrumb.

Parameters:
breadcrumbUserData: The breadcrumbUserData that was clicked.
evt: The event.

onClickSeparator(breadcrumbUserData, separator, evt)

Event fired when clicking on the separator to the right of an item

Parameters:
breadcrumbUserData: The breadcrumbUserData for the item to the left of the separator that was clicked.
separator: The separator widget.
evt: The event.

Since:: 2.0.3

onCompleteRendering()

This event method is called after the properties have been rendered.

Since:: 2.0.3.3

onPop(bc)

Event fired when a breadcrumb item is popped (removed from the breadcrumb list).

Parameters:
bc: The breadcrumb item that is popped.

pop(bc)

Pops the specified breadcrumb item. (Removes the specified breadcrumb item from the breadcrumb list.)

Parameters:
bc

postCreate()

push(bc)

Pushes the specified breadcrumb item onto the breadcrumb list.

Parameters:
bc

setData(breadcrumbArray)

Creates a _SimpleBreadcrumb for each item in the array.

Parameters:
breadcrumbArray: Array of breadcrumb data. Each item in the array should have a label, an optional title, an optional labelPrefix.