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 |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Array of ecm.model.AttributeDefinitions objects.
|
|
The symbolic name of the text search Rank column.
|
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- expandable, fitContentArea, lockFullscreen
Method Summary
Method Attributes | Method Name and Description |
---|---|
Constructor.
|
|
destroy()
Cleans up the widget.
|
|
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.
|
|
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, excludedProperties)
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, setExpandable, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar
Field Detail
attributeDefinitions
- Since:
- 2.0.2
RANK
Method Detail
constructor()
destroy()
getResultsDisplay()
- Returns:
- The search results display item that contains the selected search display properties, sort by property and sort direction setting.
onChange()
onSave()
postCreate()
processSearchResultsDisplay(searchResultsDisplay, textSearchCriteriaDefined)
- 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)
- Parameters:
- attributeDefinitions
- An array of attribute definitions.
setContentClass(contentClass, includeSubclasses, objectType, excludedProperties)
- 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".
- excludedProperties
- An array of property names that will be made unavailable for selection. If not supplied, the repository's list of filtered properties is used instead (i.e., this.repositoy.searchFilteredDocumentProperties).
setObjectType(objectType)
- 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)
- Parameters:
- repository
- Instance of ecm.model.Repository
setResultsDisplay(resultsDisplay, isDataNotNormalized)
- Parameters:
- resultsDisplay
- An object with the following attributes.
sortBy: The ID of the property to sort by sortAsc: A Boolean indicating whether to sort search results in ascending order columns: An array of property identifiers representing the search result columns magazineColumns: An array of property identifiers representing the search result columns displayed in the magazine view honorNameProperty: A Boolean indicating whether to honor the label of the repository's designated name property (typically Document Title in FileNet P8) by showing it as-is on the column header or as the pseudo "Name" property showContentSummary: A Boolean indicating whether to enable content summaries in the magazine view (FileNet P8 text searches only)
- 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)
- Parameters:
- showClassProperty
- Boolean indicating whether to show the pseudo class property
setTextSearchEnabled(enabled)
- Parameters:
- enabled
- A boolean value indicating that text search is enabled.