Class ecm.widget.listView.Filmstrip

Extends dijit._Widget, dijit._TemplatedMixin, dijit._WidgetsInTemplateMixin.
Provides a widget that displays a filmstrip view of content.
Defined in: <ecm\widget\listView\Filmstrip.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.listView.Filmstrip()

Field Summary

Field Attributes	Field Name and Description
	emptyInfo Message to show if there is no data to show in the filmstrip.
	isDragCopy Boolean indicating that it should be in copy state when start dragging a filmstrip item.
	isDraggingAllowed Boolean that indicates whether dragging a filmstrip item is allowed.

Method Summary

Method Attributes	Method Name and Description
	canDropItems(dropItem, evt, isCopy) Optionally override in your application.
	canDropOnItem(dropItem, evt) Optionally override in your application.
	clearFilter() Clears the filter.
	deleteItem(item) Handles deletion of the input item.
	filter(ids) Filters the filmstrip.
	onDrop(dropItem, files, evt) Event fired when files from the desktop are dropped on an item in the filmstrip.
	onDropItems(dropItem, files, evt) Event fired when internal items are dropped on an item in the filmstrip.
	onItemContextMenu(entry, evt) Event fired when an item in the filmstrip should show its context menu.
	onItemDblClick(entry) Event fired when an item in the filmstrip is double clicked.
	onItemDeselected(entry) Event fired when an item in the filmstrip is selected.
	onItemSelected(entry) Event fired when an item in the filmstrip is selected.
	postCreate()
	render(items) Builds the filmstrip list.
	resize() Resizes the widget.
	scrollToItem(item) Scrolls to the item.
	selectItems(items) Selects the specified items.
	update(item) Handles updates to the input item.

Constructor Detail

ecm.widget.listView.Filmstrip()

Field Detail

emptyInfo

Message to show if there is no data to show in the filmstrip. Default is no message.

isDragCopy

Boolean indicating that it should be in copy state when start dragging a filmstrip item. If true, then when a drag is started, the avatar will be "copy".

isDraggingAllowed

Boolean that indicates whether dragging a filmstrip item is allowed. If false, then the user cannot start dragging filmstrip items.

Method Detail

canDropItems(dropItem, evt, isCopy)

Optionally override in your application. Return true if can drop internal documents on the dropItem.

Parameters:
dropItem: The item to drop on. Can be null if dragging over the white space in the filmstrip.
evt: The event.
isCopy

canDropOnItem(dropItem, evt)

Optionally override in your application. Return true if can drop files from the desktop on the dropItem.

Parameters:
dropItem: The item to drop on. Can be null if dragging over the white space in the filmstrip.
evt: The event.

clearFilter()

Clears the filter.

deleteItem(item)

Handles deletion of the input item.

Parameters:
item

filter(ids)

Filters the filmstrip.

Parameters:
ids: Array of item ids for the items to show. Any item not in the list will be hidden.

onDrop(dropItem, files, evt)

Event fired when files from the desktop are dropped on an item in the filmstrip.

Parameters:
dropItem: The item dropped on. Can be null if dropped on the white space in the filmstrip.
files: The files dragged from the desktop.
evt: The event.

onDropItems(dropItem, files, evt)

Event fired when internal items are dropped on an item in the filmstrip.

Parameters:
dropItem: The item dropped on. Can be null if dropped on the white space in the filmstrip.
files: The files dragged from the desktop.
evt: The event.

onItemContextMenu(entry, evt)

Event fired when an item in the filmstrip should show its context menu.

Parameters:
entry: Instance of ecm.widget.listView._FilmstripEntry.
evt: The event.

onItemDblClick(entry)

Event fired when an item in the filmstrip is double clicked.

Parameters:
entry: Instance of ecm.widget.listView._FilmstripEntry.

onItemDeselected(entry)

Event fired when an item in the filmstrip is selected.

Parameters:
entry: Instance of ecm.widget.listView._FilmstripEntry.

onItemSelected(entry)

Event fired when an item in the filmstrip is selected.

Parameters:
entry: Instance of ecm.widget.listView._FilmstripEntry.

postCreate()

render(items)

Builds the filmstrip list.

Parameters:
items: Array of ecm.model.Item or ecm.model.Favorite.

resize()

Resizes the widget.

scrollToItem(item)

Scrolls to the item.

Parameters:
item: Instance of ecm.model.Item or ecm.model.Favorite.

selectItems(items)

Selects the specified items.

Parameters:
items: Array of ecm.model.Item or ecm.model.Favorite.

update(item)

Handles updates to the input item.

Parameters:
item: Instance of ecm.model.Item or ecm.model.Favorite.