Class Index | File Index

Classes


Namespace orion.searchUtils

orion.searchUtils
Defined in: </shared/eclipse/e4/orion/I201210191304/plugins/org.eclipse.orion.client.core/web/orion/searchUtils.js>.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Utility methods
Method Summary
Method Attributes Method Name and Description
<static>  
orion.searchUtils.addRecentSearch(serviceRegistry, searchName, useRegEx)
<static>  
orion.searchUtils.copyQueryParams(queryObj, copyReplace)
<static>  
orion.searchUtils.findRegExp(pattern, flags, startIndex, startIndex)
Helper for finding regex matches in text contents.
<static>  
orion.searchUtils.fullPathNameByMeta(parents)
<static>  
orion.searchUtils.generateFindURLBinding(inFileQuery, lineNumber, replaceStr)
<static>  
orion.searchUtils.generateInFileQuery(searchStr, fromStart)
<static>  
orion.searchUtils.generateInFileQueryRegEx(searchStr, fromStart)
<static>  
orion.searchUtils.generateMatchContext(contextAroundLength, fileContents, lineNumber)
<static>  
orion.searchUtils.generateNewContents(oldContents, newContents, fileModelNode, replaceStr, searchStrLength)
<static>  
orion.searchUtils.generateSearchHref(options)
<static>  
orion.searchUtils.generateSearchQuery(options)
<static>  
orion.searchUtils.getMixedSearches(serviceRegistry, mixed, callback)
<static>  
orion.searchUtils.getOpenSearchPref(serviceRegistry, callback)
<static>  
orion.searchUtils.getSearches(serviceRegistry, type, callback)
<static>  
orion.searchUtils.parseFindURLBinding(findParam)
<static>  
orion.searchUtils.parseLocationAndSearchStr(locAndSearchStr, queryObj, fromStart)
<static>  
orion.searchUtils.parseLocationAndSearchStrRegEx(locAndSearchStr, queryObj, fromStart)
 
parseQueryStr(queryStr)
Parse the search query string from the hash value of a search page.
<static>  
orion.searchUtils.parseQueryStr(queryStr, fromStart)
<static>  
orion.searchUtils.path2FolderName(filePath, fileName, keepTailSlash)
<static>  
orion.searchUtils.populateSearchMenu(serviceRegistry, choicesMenu, type, makeLabelFunc)
<static>  
orion.searchUtils.replaceCheckedMatches(text, replacingStr, originalMatches, checkedMatches, defaultMatchLength)
<static>  
orion.searchUtils.replaceRegEx(text, regEx, replacingStr)
<static>  
orion.searchUtils.replaceStringLiteral(text, keyword, replacingStr)
<static>  
orion.searchUtils.searchOnelineLiteral(inFileQuery, lineString, onlyOnce)
<static>  
orion.searchUtils.searchOnelineRegEx(inFileQuery, lineString, onlyOnce)
<static>  
orion.searchUtils.searchWithinFile(inFileQuery, fileModelNode, fileContentText, lineDelim, replacing, caseSensitive)
<static>  
orion.searchUtils.setOpenSearchPref(serviceRegistry, openInNewTab)
<static>  
orion.searchUtils.splitFile(text)
 
splitFile(text)
Split file contents into lines.
Namespace Detail
orion.searchUtils
Utility methods
Method Detail
<static> orion.searchUtils.addRecentSearch(serviceRegistry, searchName, useRegEx)
Parameters:
serviceRegistry
searchName
useRegEx

<static> orion.searchUtils.copyQueryParams(queryObj, copyReplace)
Parameters:
queryObj
copyReplace

<static> {Object} orion.searchUtils.findRegExp(pattern, flags, startIndex, startIndex)
Helper for finding regex matches in text contents.
Parameters:
{String} pattern
A valid regexp pattern.
{String} flags
Valid regexp flags: [is]
{Number} startIndex Optional
Default is false.
startIndex
Returns:
{Object} An object giving the match details, or null if no match found. The returned object will have the properties:
{Number} index
{Number} length

<static> orion.searchUtils.fullPathNameByMeta(parents)
Parameters:
parents

<static> orion.searchUtils.generateFindURLBinding(inFileQuery, lineNumber, replaceStr)
Parameters:
inFileQuery
lineNumber
replaceStr

<static> orion.searchUtils.generateInFileQuery(searchStr, fromStart)
Parameters:
searchStr
fromStart

<static> orion.searchUtils.generateInFileQueryRegEx(searchStr, fromStart)
Parameters:
searchStr
fromStart

<static> orion.searchUtils.generateMatchContext(contextAroundLength, fileContents, lineNumber)
Parameters:
contextAroundLength
fileContents
lineNumber

<static> orion.searchUtils.generateNewContents(oldContents, newContents, fileModelNode, replaceStr, searchStrLength)
Parameters:
oldContents
newContents
fileModelNode
replaceStr
searchStrLength

<static> orion.searchUtils.generateSearchHref(options)
Parameters:
options

<static> orion.searchUtils.generateSearchQuery(options)
Parameters:
options

<static> orion.searchUtils.getMixedSearches(serviceRegistry, mixed, callback)
Parameters:
serviceRegistry
mixed
callback

<static> orion.searchUtils.getOpenSearchPref(serviceRegistry, callback)
Parameters:
serviceRegistry
callback

<static> orion.searchUtils.getSearches(serviceRegistry, type, callback)
Parameters:
serviceRegistry
type
callback

<static> orion.searchUtils.parseFindURLBinding(findParam)
Parameters:
findParam

<static> orion.searchUtils.parseLocationAndSearchStr(locAndSearchStr, queryObj, fromStart)
Parameters:
locAndSearchStr
queryObj
fromStart

<static> orion.searchUtils.parseLocationAndSearchStrRegEx(locAndSearchStr, queryObj, fromStart)
Parameters:
locAndSearchStr
queryObj
fromStart

{Object} parseQueryStr(queryStr)
Parse the search query string from the hash value of a search page.
Parameters:
{String} queryStr
The hash string.
Returns:
{Object} An object having the properties:
  • Integer start The start number of search result of current page.
  • Integer rows The max rows per page.
  • String sort The sort parameters."Path asc" or "Name asc".
  • Object inFileQuery The query object for in file search.

<static> orion.searchUtils.parseQueryStr(queryStr, fromStart)
Parameters:
queryStr
fromStart

<static> orion.searchUtils.path2FolderName(filePath, fileName, keepTailSlash)
Parameters:
filePath
fileName
keepTailSlash

<static> orion.searchUtils.populateSearchMenu(serviceRegistry, choicesMenu, type, makeLabelFunc)
Parameters:
serviceRegistry
choicesMenu
type
makeLabelFunc

<static> orion.searchUtils.replaceCheckedMatches(text, replacingStr, originalMatches, checkedMatches, defaultMatchLength)
Parameters:
text
replacingStr
originalMatches
checkedMatches
defaultMatchLength

<static> orion.searchUtils.replaceRegEx(text, regEx, replacingStr)
Parameters:
text
regEx
replacingStr

<static> orion.searchUtils.replaceStringLiteral(text, keyword, replacingStr)
Parameters:
text
keyword
replacingStr

<static> orion.searchUtils.searchOnelineLiteral(inFileQuery, lineString, onlyOnce)
Parameters:
inFileQuery
lineString
onlyOnce

<static> orion.searchUtils.searchOnelineRegEx(inFileQuery, lineString, onlyOnce)
Parameters:
inFileQuery
lineString
onlyOnce

<static> orion.searchUtils.searchWithinFile(inFileQuery, fileModelNode, fileContentText, lineDelim, replacing, caseSensitive)
Parameters:
inFileQuery
fileModelNode
fileContentText
lineDelim
replacing
caseSensitive

<static> orion.searchUtils.setOpenSearchPref(serviceRegistry, openInNewTab)
Parameters:
serviceRegistry
openInNewTab

<static> orion.searchUtils.splitFile(text)
Parameters:
text

{Array} splitFile(text)
Split file contents into lines. It also handles the mixed line endings with "\n", "\r" and "\r\n".
Parameters:
{String} text
The file contetns.
Returns:
{Array} Split file lines.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 19 2012 13:08:15 GMT-0400 (EDT)