Class ecm.widget.search.SearchTab

Extends dijit._WidgetBase.
Provides a widget that contains a ecm.widget.search.SearchForm widget and a ecm.widget.listView.ContentList widget with the widget events wired together. The parent for the SearchTab widget is an idx.widget.ContentPane or other widget that passes the container attribute to this widget.
Defined in: <ecm\widget\search\SearchTab.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.search.SearchTab()

Field Summary

Field Attributes	Field Name and Description
	hideSearchCriteria Indicates whether to automatically run the search and hide the search criteria when loaded.
	openItemOnLoad Indicates whether to automatically open the first item in the results list if the search runs automatically when opened and returns a single item.
	runSearchOnLoad Indicates whether to automatically run the search when loaded.
	searchFeatureId The ID of the search feature that hosts this search tab.
	searchTemplate A ecm.model.SearchTemplate object of the search being opened
	showClear
	showEdit
	showingContentList
	showingSearchToggleArea
	version The version of the search to be opened, i.e.

Method Summary

Method Attributes	Method Name and Description
	_meetsMinimumCriteria() Returns true if the search meets the the minimum criteria requirements to run.
	_search(callback) Runs the search if the criteria is valid.
	_showMessage(message) Displays the given message in a modal dialog.
	constructor(cArgs)
	onLoad()
	resetPanes()
	resizeSearchCriteria() Resizes the search criteria pane of this widget.

Constructor Detail

ecm.widget.search.SearchTab()

Field Detail

hideSearchCriteria

Indicates whether to automatically run the search and hide the search criteria when loaded. Only applicable to searches that are free of errors, and meet the minimum criteria requirements.

Since:: 2.0.3

openItemOnLoad

Indicates whether to automatically open the first item in the results list if the search runs automatically when opened and returns a single item.

Since:: 2.0.3.5

runSearchOnLoad

Indicates whether to automatically run the search when loaded. Only applicable to searches that are free of errors, and meet the minimum criteria requirements.

Since:: 2.0.3

searchFeatureId

The ID of the search feature that hosts this search tab.

Since:: 2.0.3

searchTemplate

A ecm.model.SearchTemplate object of the search being opened

showClear

Deprecated:: As of release 2.0.1

showEdit

Deprecated:: As of release 2.0.1

showingContentList

Deprecated:: As of release 2.0.1

showingSearchToggleArea

Deprecated:: As of release 2.0.1

version

The version of the search to be opened, i.e., "current", "released" or "specific". If not defined, the released version is opened.

Since:: 2.0.3

Method Detail

_meetsMinimumCriteria()

Returns true if the search meets the the minimum criteria requirements to run. This method is responsible for prompting the user for additional criteria before returning false. For example, this._showMessage(this.messages.search_insufficient_input);.

Returns:: true if the search meets the the minimum criteria requirements to run

_search(callback)

Runs the search if the criteria is valid.

Parameters:
callback

_showMessage(message)

Displays the given message in a modal dialog.

Parameters:
message: The message to be displayed

constructor(cArgs)

Parameters:
cArgs

onLoad()

resetPanes()

Deprecated:: As of release 2.0.1

resizeSearchCriteria()

Resizes the search criteria pane of this widget.