Package | com.adobe.livecycle.rca.model |
Classe | public class Review |
Héritage | Review Object |
Implémente | IEventDispatcher |
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Review
object as returned by the searchReview API.
This a container object that contains all versions for a given review ID.
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
currentStageName : String
Specifies the name of the current stage. | Review | ||
currentStageNumber : int
Specifies the number of the current stage. | Review | ||
endDate : Date Specifies the end date of the review. | Review | ||
initiator : BaseUser Specifies the initiator of the review. | Review | ||
purpose : String Specifies the purpose of the review provided by the user. | Review | ||
reviewId : String Specifies the Managed Review And Approval Process unique identifier provided by the system. | Review | ||
reviews : ArrayCollection
Specifies a collection of all the revisions of review. | Review | ||
revision : int Specifies the revision of the review. | Review | ||
startDate : Date Specifies the start date of the review. | Review | ||
status : String Specifies the status of the review. | Review | ||
title : String Specifies the title of the review provided by the user. | Review | ||
totalStages : String
Specifies the total number of stages. | Review |
Méthode | Défini par | ||
---|---|---|---|
Review()
Constructor. | Review | ||
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. | Review | ||
Dispatches an event into the event flow. | Review | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Review | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Removes a listener from the EventDispatcher object. | Review | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | Review |
currentStageName | propriété |
currentStageName:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the name of the current stage. That is, the stage that is in progress.
Implémentation
public function get currentStageName():String
public function set currentStageName(value:String):void
currentStageNumber | propriété |
currentStageNumber:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the number of the current stage. This property contains the index of the stage that is in progress. The initial value is 1.
Implémentation
public function get currentStageNumber():int
public function set currentStageNumber(value:int):void
endDate | propriété |
endDate:Date
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the end date of the review. This date is same as the end date for the last complete, expired, or revoked stage.
Implémentation
public function get endDate():Date
public function set endDate(value:Date):void
initiator | propriété |
initiator:BaseUser
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the initiator of the review.
Implémentation
public function get initiator():BaseUser
public function set initiator(value:BaseUser):void
purpose | propriété |
purpose:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the purpose of the review provided by the user.
Implémentation
public function get purpose():String
public function set purpose(value:String):void
reviewId | propriété |
reviewId:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the Managed Review And Approval Process unique identifier provided by the system.
Implémentation
public function get reviewId():String
public function set reviewId(value:String):void
reviews | propriété |
reviews:ArrayCollection
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a collection of all the revisions of review.
Because the initial value is 0, to fetch a specific revision based on the revision field, use reviews.getItemAt(revision - 1)
.
Implémentation
public function get reviews():ArrayCollection
public function set reviews(value:ArrayCollection):void
Eléments de l’API associés
revision | propriété |
revision:int
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the revision of the review. The initial value is 1.
Implémentation
public function get revision():int
public function set revision(value:int):void
startDate | propriété |
startDate:Date
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the start date of the review. This date is same as the start date for first stage.
Implémentation
public function get startDate():Date
public function set startDate(value:Date):void
status | propriété |
status:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the status of the review.
Implémentation
public function get status():String
public function set status(value:String):void
title | propriété |
title:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the title of the review provided by the user. It is a meaningful name for the review that can be used to search reviews.
Implémentation
public function get title():String
public function set title(value:String):void
totalStages | propriété |
totalStages:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the total number of stages.
Implémentation
public function get totalStages():String
public function set totalStages(value:String):void
Review | () | Constructeur |
public function Review()
Version du langage: | ActionScript 3.0 |
Version du produit: | Bloc de création Review, Commenting & Approval 9.5 |
Versions du moteur d’exécution: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Constructor.
addEventListener | () | méthode |
public function 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. 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).
Paramètres
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 ) — Determines whether the listener works in the capture phase or the target
and bubbling phases. If 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 ) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
| |
weakRef:Boolean (default = false ) — Determines whether the reference to the listener is strong or weak. A strong
reference (the default) prevents your listener from being garbage-collected. A weak
reference does not. Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | méthode |
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.
Paramètres
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 | () | méthode |
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.
Paramètres
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | méthode |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes 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.
Paramètres
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false ) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true , and another call with useCapture set to false .
|
willTrigger | () | méthode |
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.
Paramètres
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Tue Jun 12 2018, 09:30 AM Z