| Package | com.adobe.livecycle.rca.model |
| Class | public class ReviewContext |
| Inheritance | ReviewContext  Object |
| Implements | IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| additionalMetaData : String Specifies any data specific to this review to save. | ReviewContext | ||
| arsProcessName : String Specifies the name of the process that is used to generate an approval routing sheet. | ReviewContext | ||
| auditLevel : String Specifies the level of audit associated with this review. | ReviewContext | ||
| commentServerPath : String [read-only] Specifies the location of the server where Adobe Acrobat stores inline comments. | ReviewContext | ||
| commentVisibility : String Specifies whether Adobe Acrobat inline comments that are added in one stage are visible in other stages. | ReviewContext | ||
| complianceCode : String Specifies a value that represents the legislation that this review complies with. | ReviewContext | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentStage : int Specifies the current stage of the review. | ReviewContext | ||
| customAttributes : ArrayCollection Specifies a list of custom attributes. | ReviewContext | ||
| initiator : Initiator Specifies the initiator of the review. | ReviewContext | ||
| purpose : String
Specifies a purpose for the review provided by the user. | ReviewContext | ||
| reviewId : String Specifies a unique identifier generated by the Managed Review and Approval Process building block. | ReviewContext | ||
| revision : int Specifies a revision of this review. | ReviewContext | ||
| rtsProcessName : String Specifies the name of the process that is used to generate a review tracking sheet. | ReviewContext | ||
| stages : StageCollection Specifies a collection of stages. | ReviewContext | ||
| status : String Specifies the status of the Managed Review and Approval building block process. | ReviewContext | ||
| straightThroughProcessing : Boolean Specifies whether the review process moves to the next stage after a stage is complete. | ReviewContext | ||
| supportingDocuments : DocumentCollection Specifies a collection of supporting documents. | ReviewContext | ||
| templateAuthor : String Specifies the author of the template that was used to initiate a review. | ReviewContext | ||
| templateDesc : String Specifies the description of the template that is used to initiate a review. | ReviewContext | ||
| templateIsActive : Boolean Specifies whether the template that is used to initiate a review
is an active process. | ReviewContext | ||
| templateName : String Specifies the name of the template that is used to initiate a review. | ReviewContext | ||
| title : String Specifies a review title provided by the user. | ReviewContext | ||
| type : String Specifies the type of review. | ReviewContext | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ReviewContext | ||
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. | ReviewContext | ||
Dispatches an event into the event flow. | ReviewContext | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | ReviewContext | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes a listener from the EventDispatcher object. | ReviewContext | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | ReviewContext | ||
additionalMetaData | property |
additionalMetaData:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies any data specific to this review to save.
Implementation
public function get additionalMetaData():String public function set additionalMetaData(value:String):voidarsProcessName | property |
arsProcessName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the name of the process that is used to generate an approval routing sheet.
Implementation
public function get arsProcessName():String public function set arsProcessName(value:String):voidauditLevel | property |
auditLevel:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the level of audit associated with this review. This level is used by the Audit Module to audit review actions.
Implementation
public function get auditLevel():String public function set auditLevel(value:String):voidcommentServerPath | property |
commentServerPath:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the location of the server where Adobe Acrobat stores inline comments. This property is populated by the system.
Implementation
public function get commentServerPath():StringcommentVisibility | property |
commentVisibility:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies whether Adobe Acrobat inline comments that are added in one stage are visible in other stages. If the value is INTER_STAGE, comments are shared across stages. If the value is ONLY_INTRA_STAGE, comments added in a stage are hidden in other stages.
The default value is ReviewCommentVisibility.ONLY_INTRA_STAGE.
Implementation
public function get commentVisibility():String public function set commentVisibility(value:String):voidRelated API Elements
complianceCode | property |
complianceCode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a value that represents the legislation that this review complies with. A regulated review is associated with a legislative requirement.
Implementation
public function get complianceCode():String public function set complianceCode(value:String):voidcurrentStage | property |
currentStage:int| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the current stage of the review. This property is populated by the system and points to the stage number that is in progress. The initial value is 1.
Implementation
public function get currentStage():int public function set currentStage(value:int):voidcustomAttributes | property |
customAttributes:ArrayCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a list of custom attributes.
Implementation
public function get customAttributes():ArrayCollection public function set customAttributes(value:ArrayCollection):voidRelated API Elements
initiator | property |
initiator:Initiator| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the initiator of the review.
Implementation
public function get initiator():Initiator public function set initiator(value:Initiator):voidpurpose | property |
purpose:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a purpose for the review provided by the user.
Implementation
public function get purpose():String public function set purpose(value:String):voidreviewId | property |
reviewId:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a unique identifier generated by the Managed Review and Approval Process building block. This ID can be used to look up other information related to a review. It should not be set by the client.
Implementation
public function get reviewId():String public function set reviewId(value:String):voidrevision | property |
revision:int| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a revision of this review. The initial value is 1. Each time the review is revised, the value increases by 1.
Use the reviewId and revision properties together to retrieve a specific revision of a review.
Implementation
public function get revision():int public function set revision(value:int):voidrtsProcessName | property |
rtsProcessName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the name of the process that is used to generate a review tracking sheet.
Implementation
public function get rtsProcessName():String public function set rtsProcessName(value:String):voidstages | property |
stages:StageCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a collection of stages.
Since the initial value of the collection is 0, to fetch a specific stage based on
currentStage field, use stages.getItemAt(currentStage - 1).
Implementation
public function get stages():StageCollection public function set stages(value:StageCollection):voidstatus | property |
status:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the status of the Managed Review and Approval building block process.
The default value is ReviewStatus.ONGOING.
Implementation
public function get status():String public function set status(value:String):voidRelated API Elements
straightThroughProcessing | property |
straightThroughProcessing:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies whether the review process moves to the next stage after a stage is complete.
If true, the review process moves to next stage directly.
If false, a task is assigned to the initiator when a stage is complete.
Use this task to enable the initiator to revise the review by uploading a new document.
The default value is true.
Implementation
public function get straightThroughProcessing():Boolean public function set straightThroughProcessing(value:Boolean):voidsupportingDocuments | property |
supportingDocuments:DocumentCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a collection of supporting documents. This is a list of documents for reviewers and approvers to refer to.
Implementation
public function get supportingDocuments():DocumentCollection public function set supportingDocuments(value:DocumentCollection):voidtemplateAuthor | property |
templateAuthor:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the author of the template that was used to initiate a review.
Implementation
public function get templateAuthor():String public function set templateAuthor(value:String):voidtemplateDesc | property |
templateDesc:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the description of the template that is used to initiate a review.
Implementation
public function get templateDesc():String public function set templateDesc(value:String):voidtemplateIsActive | property |
templateIsActive:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies whether the template that is used to initiate a review is an active process.
Implementation
public function get templateIsActive():Boolean public function set templateIsActive(value:Boolean):voidtemplateName | property |
templateName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the name of the template that is used to initiate a review.
Implementation
public function get templateName():String public function set templateName(value:String):voidtitle | property |
title:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies a review title provided by the user. It describes the review and can be used to search reviews.
Implementation
public function get title():String public function set title(value:String):voidtype | property |
type:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Specifies the type of review.
The default value is ReviewType.REGULATED_REVIEW.
Implementation
public function get type():String public function set type(value:String):voidRelated API Elements
ReviewContext | () | Constructor |
public function ReviewContext()| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Constructor.
addEventListener | () | method |
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).
Parameters
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 |
dispatchEvent | () | method |
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.
Parameters
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 | () | method |
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.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | method |
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.
Parameters
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.
|
willTrigger | () | method |
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.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Mon Apr 10 2017, 12:28 PM -07:00