| Пакет | lc.procmgmt.impl |
| Класс | public class FavoritesManager |
| Наследование | FavoritesManager  Object |
| Реализует | IFavoritesManager, IEventDispatcher |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
FavoritesManager class is used to manage Favorites.
Favorites is a user's list of commonly used forms (represented by
Startpoint objects) to start processes.
Use the FavoritesManager class to add, remove, load, retrieve,
and set the current favorite startpoints.
An Startpoint object can be marked as a favorite through the
FavoriteManager object, and then accessed by getting the
FavoriteManager object from the SessionMap object.
Связанные элементы API
Скрыть унаследованные общедоступные свойства
Показать унаследованные общедоступные свойства| Свойство | Определено | ||
|---|---|---|---|
 | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| favorites : ListCollectionView
The ListCollectionView object that contains a list of favorites. | FavoritesManager | ||
| Метод | Определено | ||
|---|---|---|---|
FavoritesManager(session:SessionMap)
Constructor. | FavoritesManager | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | FavoritesManager | ||
Adds an startpoint to the Favorites collection. | FavoritesManager | ||
Dispatches an event into the event flow. | FavoritesManager | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | FavoritesManager | ||
|
Показывает, определено ли заданное свойство для объекта. | Object | |
Returns whether the specified startpoint is a favorite. | FavoritesManager | ||
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
Removes a listener from the EventDispatcher object. | FavoritesManager | ||
Removes an startpoint from the Favorites collection. | FavoritesManager | ||
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | FavoritesManager | ||
| Константа | Определено | ||
|---|---|---|---|
| SESSION_KEY : String = "lc.procmgmt.IFavoritesManager" [статические]
A special value that specifies the manager key name in the SessionMap object. | FavoritesManager | ||
favorites | свойство |
favorites:ListCollectionView| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The ListCollectionView object that contains a list of favorites.
Реализация
public function get favorites():ListCollectionView public function set favorites(value:ListCollectionView):voidFavoritesManager | () | Конструктор |
public function FavoritesManager(session:SessionMap)| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Параметрыsession:SessionMap — Specifies the SessionMap to get the PreferencesManager and StartpointManager from.
|
addEventListener | () | метод |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's priority, you
must first call removeEventListener(). Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener() with a different value for either type or useCapture result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture set to true, it listens only during the capture phase. If you
call addEventListener() again using the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
Параметры
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
addToFavorites | () | метод |
public function addToFavorites(startpoint:Startpoint):lc.foundation.util:Token| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Adds an startpoint to the Favorites collection.
Параметры
startpoint:Startpoint — Specifies the startpoint to add to the favorites.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation has completed.
|
dispatchEvent | () | метод |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Параметры
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | метод |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Параметры
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
isFavorite | () | метод |
public function isFavorite(startpoint:Startpoint):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns whether the specified startpoint is a favorite.
Параметры
startpoint:Startpoint — Specifies the startpoint to add as a favorite.
|
Boolean — A flag that indicates whether an startpoint is a favorite. A value of
true specifies that it is a favorite.
|
removeEventListener | () | метод |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Параметры
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
removeFromFavorites | () | метод |
public function removeFromFavorites(startpoint:Startpoint):lc.foundation.util:Token| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Removes an startpoint from the Favorites collection.
Параметры
startpoint:Startpoint — Specifies the startpoint to remove from the favorites.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is completed.
|
willTrigger | () | метод |
public function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Параметры
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
SESSION_KEY | Константа |
public static const SESSION_KEY:String = "lc.procmgmt.IFavoritesManager"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies the manager key name in the SessionMap object.
Tue Jun 12 2018, 11:34 AM Z