Class Alfresco.Search
Extends Alfresco.component.Base
Search component.
Defined in: search.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.Search(htmlId)
Search constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Current visible page index - counts from 1
|
|
|
True if there are more results than the ones listed in the table.
|
|
|
Object container for initialization options
|
|
|
Number of search results.
|
|
|
Whether the search was over all sites or just the current one
|
|
|
Whether the search is over the entire repository - in preference to site or all sites
|
|
|
Search sort used for the last search.
|
|
|
Search tag used for the last search.
|
|
|
Search term used for the last search.
|
- Fields borrowed from class Alfresco.component.Base:
- modules, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
onAllSiteSearch(e, args)
Click event for All Sites search link
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onRepositorySearch(e, args)
Click event for Repository search link
|
|
|
onSearch(layer, args)
Execute Search event handler
|
|
|
onSearchClick(e, obj)
Event handler that gets fired when user clicks the Search button.
|
|
|
onSiteSearch(e, args)
Click event for Current Site search link
|
|
|
refreshSearch(args)
Refresh the search page by full URL refresh
|
|
|
searchByTag(param)
Perform a search for a given tag
|
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.Search(htmlId)
Search constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.Search} The new Search instance
Field Detail
currentPage
Current visible page index - counts from 1
hasMoreResults
True if there are more results than the ones listed in the table.
{object}
options
Object container for initialization options
resultsCount
Number of search results.
searchAllSites
Whether the search was over all sites or just the current one
searchRepository
Whether the search is over the entire repository - in preference to site or all sites
searchSort
Search sort used for the last search.
searchTag
Search tag used for the last search.
searchTerm
Search term used for the last search.
Method Detail
onAllSiteSearch(e, args)
Click event for All Sites search link
- Parameters:
- e
- args
onReady()
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.
Component initialisation, including instantiation of YUI widgets and event listener binding.
onRepositorySearch(e, args)
Click event for Repository search link
- Parameters:
- e
- args
onSearch(layer, args)
Execute Search event handler
- Parameters:
- {object} layer
- Event fired
- {array} args
- Event parameters (depends on event type)
onSearchClick(e, obj)
Event handler that gets fired when user clicks the Search button.
- Parameters:
- {object} e
- DomEvent
- {object} obj
- Object passed back from addListener method
onSiteSearch(e, args)
Click event for Current Site search link
- Parameters:
- e
- args
refreshSearch(args)
Refresh the search page by full URL refresh
- Parameters:
- {object} args
- search args
searchByTag(param)
Perform a search for a given tag
The tag is simply handled as search term
The tag is simply handled as search term
- Parameters:
- param