Class ecm.widget.search.SearchResultsDisplayOptions

Extends ecm.widget.dialog.BaseDialog.
Provides a widget that contains the columns that are used to display search results. The search results can be sorted by a property in descending or ascending order. If the text search is enabled, the search results can be sorted by rank in descending order.
Defined in: <ecm\widget\search\SearchResultsDisplayOptions.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	attributeDefinitions Array of ecm.model.AttributeDefinitions objects.
	RANK The symbolic name of the text search Rank column.

Fields borrowed from class ecm.widget.dialog.BaseDialog:: fitContentArea, lockFullscreen

Method Summary

Method Attributes	Method Name and Description
	constructor() Constructor.
	destroy() Cleans up the widget.
	getResultsDisplay() Returns the search results display settings.
	onChange() An event that is triggered when the search results display pane onChange event is fired.
	onSave() An event that is triggered when the OK button is selected.
	postCreate() Launches after the widget is created.
	processSearchResultsDisplay(searchResultsDisplay, textSearchCriteriaDefined) Initializes the search results display settings based on whether the text search criteria is defined by the search.
	setAttributeDefinitions(attributeDefinitions) Sets the selected search content class.
	setContentClass(contentClass, includeSubclasses, objectType) Sets the selected search content class.
	setObjectType(objectType) Sets the search object type.
	setRepository(repository) Sets the repository.
	setResultsDisplay(resultsDisplay, isDataNotNormalized) Sets the search results display settings.
	setShowClassProperty(showClassProperty) Indicates whether to show the pseudo class property.
	setTextSearchEnabled(enabled) Sets to true to enable text search Rank column.
	show() Shows the search results display dialog box.

Methods borrowed from class ecm.widget.dialog.BaseDialog:: addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, hide, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar

Constructor Detail

ecm.widget.search.SearchResultsDisplayOptions()

Field Detail

attributeDefinitions

Array of ecm.model.AttributeDefinitions objects.

Since:: 2.0.2

RANK

The symbolic name of the text search Rank column.

Method Detail

constructor()

Constructor.

destroy()

Cleans up the widget.

getResultsDisplay()

Returns the search results display settings.

Returns:: The search results display item that contains the selected search display properties, sort by property and sort direction setting.

onChange()

An event that is triggered when the search results display pane onChange event is fired.

onSave()

An event that is triggered when the OK button is selected.

postCreate()

Launches after the widget is created.

processSearchResultsDisplay(searchResultsDisplay, textSearchCriteriaDefined)

Initializes the search results display settings based on whether the text search criteria is defined by the search.

Parameters:
searchResultsDisplay: The search results display item that contains the selected search display properties, sort by property and sort direction setting.
textSearchCriteriaDefined: A boolean value indicating if text search criteria is defined by the search.

setAttributeDefinitions(attributeDefinitions)

Sets the selected search content class.

Parameters:
attributeDefinitions: An array of attribute definitions.

setContentClass(contentClass, includeSubclasses, objectType)

Sets the selected search content class.

Parameters:
contentClass: Instance of ecm.model.ContentClass.
includeSubclasses: A boolean value indicating to include all subclasses attributes.
objectType: The type of object the search is querying, i.e., "document" or "folder".

setObjectType(objectType)

Sets the search object type.

Parameters:
objectType: The object type of the search for which to get the name property.

Deprecated:: As of 2.0.3.3. Use setContentClass.

setRepository(repository)

Sets the repository.

Parameters:
repository: Instance of ecm.model.Repository

setResultsDisplay(resultsDisplay, isDataNotNormalized)

Sets the search results display settings.

Parameters:
resultsDisplay: The search results display item that contains the selected search display properties, sort by property and sort direction setting.
isDataNotNormalized: A boolean value indicating that the search results display properties should be validated to see if they have been filtered out by configuration.

setShowClassProperty(showClassProperty)

Indicates whether to show the pseudo class property.

Parameters:
showClassProperty: Boolean indicating whether to show the pseudo class property

setTextSearchEnabled(enabled)

Sets to true to enable text search Rank column.

Parameters:
enabled: A boolean value indicating that text search is enabled.

show()

Shows the search results display dialog box.