Class Index | File Index

Classes


Class orion.favorites.FavoritesService

A service for creating and managing links that the user has identified as favorites.
Defined in: </shared/eclipse/e4/orion/I201107200200/plugins/org.eclipse.orion.client.core/web/orion/favorites.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Instantiates the favorites service.
Method Summary
Method Attributes Method Name and Description
 
addFavorite(theName, thePath, isDirectory, isExternalResource)
 
addFavoriteSearch(theName, theQuery)
 
 
 
Adds an item or array of items to the favorites list.
 
 
removeSearch(query)
 
renameFavorite(path, newName)
Class Detail
orion.favorites.FavoritesService(options)
Instantiates the favorites service. Clients should obtain the orion.core.favorite service from the service registry rather than instantiating this service directly. This constructor is intended for use by page initialization code that is initializing the service registry.
Parameters:
{Object} options
The service options
Method Detail
addFavorite(theName, thePath, isDirectory, isExternalResource)
Parameters:
theName
thePath
isDirectory
isExternalResource

addFavoriteSearch(theName, theQuery)
Parameters:
theName
theQuery

addFavoriteUrl(url)
Parameters:
url

getFavorites()

makeFavorites(items)
Adds an item or array of items to the favorites list.
Parameters:
items
One or more file or directory objects

removeFavorite(path)
Parameters:
path

removeSearch(query)
Parameters:
query

renameFavorite(path, newName)
Parameters:
path
newName

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jul 20 2011 02:04:43 GMT-0400 (EDT)