Packagelc.core
Classpublic class FavoritesManager
InheritanceFavoritesManager Inheritance Object
Implements IFavoritesManager

The FavoritesManager class is used to manage Favorites. Favorites is a users' list of commonly used forms (represented by Endpoint objects) to start process.

Use the FavoritesManager class to add, remove, load, retrieve, and set the current favorite endpoints.

An Endpoint object can be marked as a favorite through the FavoriteManager object, and then accessed by getting the FavoriteManager object from the SessionMap object.

See also

lc.domain.Endpoint

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  favorites : ListCollectionView
The collection of favorites.
FavoritesManager
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
FavoritesManager(preferencesManager:IPreferencesManager, endpointManager:IEndpointManager)
Constructor.
FavoritesManager
  
addToFavorites(endpoint:Endpoint):Token
Adds an endpoint to the Favorites collection.
FavoritesManager
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
isFavorite(endpoint:Endpoint):Boolean
Returns whether the specified endpoints is a favorite.
FavoritesManager
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeFromFavorites(endpoint:Endpoint):Token
Removes an endpoint from the Favorites collection.
FavoritesManager
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
favoritesproperty
favorites:ListCollectionView  [read-write]

The collection of favorites.


Implementation
    public function get favorites():ListCollectionView
    public function set favorites(value:ListCollectionView):void
Constructor Detail
FavoritesManager()Constructor
public function FavoritesManager(preferencesManager:IPreferencesManager, endpointManager:IEndpointManager)

Constructor.

Parameters
preferencesManager:IPreferencesManager — Specifies the preferences manager from the session.
 
endpointManager:IEndpointManager — Specifies the endpoint manager from the session.
Method Detail
addToFavorites()method
public function addToFavorites(endpoint:Endpoint):Token

Adds an endpoint to the Favorites collection.

Parameters

endpoint:Endpoint

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.
isFavorite()method 
public function isFavorite(endpoint:Endpoint):Boolean

Returns whether the specified endpoints is a favorite.

Parameters

endpoint:Endpoint — Specifies the endpoint to add as a favorite.

Returns
Boolean — A flag that indicates whether an endpoint is a favorite. A value of true specifies that it is a favorite.
removeFromFavorites()method 
public function removeFromFavorites(endpoint:Endpoint):Token

Removes an endpoint from the Favorites collection.

Parameters

endpoint:Endpoint — Specifies the endpoint to remove from the favorites.

Returns
Token — A token used to set result and fault handlers to be called when the operation has completed.



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/FavoritesManager.html