Class orion.favorites.FavoritesService
A service for creating and managing links that the user has identified
as favorites.
Defined in: </shared/eclipse/e4/orion/I201306262230/plugins/org.eclipse.orion.client.ui/web/orion/favorites.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Instantiates the favorites service.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addFavorite(theName, thePath, isDirectory)
|
|
|
addFavoriteUrl(url)
|
|
|
hasFavorite(path)
|
|
|
makeFavorites(items)
Adds an item or array of items to the favorites list.
|
|
|
queryFavorites(queryText)
Queries the favorites using s pseudo-regular expression.
|
|
|
removeFavorite(path)
|
|
|
renameFavorite(path, newName)
|
Class Detail
orion.favorites.FavoritesService()
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.
Method Detail
addFavorite(theName, thePath, isDirectory)
- Parameters:
- theName
- thePath
- isDirectory
addFavoriteUrl(url)
- Parameters:
- url
getFavorites()
hasFavorite(path)
- Parameters:
- path
makeFavorites(items)
Adds an item or array of items to the favorites list.
- Parameters:
- items
- One or more file or directory objects
queryFavorites(queryText)
Queries the favorites using s pseudo-regular expression.
The format of the regex is the same as that recognized by
the open resources dialog: * represents any text, ? is a
single character. And there is an implicit * at the end of
the queryText.
Empty queryText matches all favorites
- Parameters:
- queryText
- the name of the favorites to look for.
- Returns:
- a possibly empty array of favorites that matches the queryText
removeFavorite(path)
- Parameters:
- path
renameFavorite(path, newName)
- Parameters:
- path
- newName