ReviewContext

Paket	com.adobe.livecycle.rca.model
Klasse	public class ReviewContext
Vererbung	ReviewContext Object
Implementiert	IEventDispatcher

Veraltet seit Review, Commenting, and Approval 10: Verwenden Sie com.adobe.solutions.rca.vo.ReviewContextVO

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Defines the basic structure of a review.

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		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 [schreibgeschützt] 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 Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	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

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		ReviewContext() 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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ReviewContext
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ReviewContext
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ReviewContext
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		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.	ReviewContext

Eigenschaftendetails

additionalMetaData

Eigenschaft

additionalMetaData:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies any data specific to this review to save.

Implementierung
public function get additionalMetaData():String
public function set additionalMetaData(value:String):void

arsProcessName

Eigenschaft

arsProcessName:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the name of the process that is used to generate an approval routing sheet.

Implementierung
public function get arsProcessName():String
public function set arsProcessName(value:String):void

auditLevel

Eigenschaft

auditLevel:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get auditLevel():String
public function set auditLevel(value:String):void

commentServerPath

Eigenschaft

commentServerPath:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get commentServerPath():String

commentVisibility

Eigenschaft

commentVisibility:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Der Standardwert ist ReviewCommentVisibility.ONLY_INTRA_STAGE.

Implementierung
public function get commentVisibility():String
public function set commentVisibility(value:String):void

Verwandte API-Elemente

com.adobe.livecycle.rca.model.constant.ReviewCommentVisibility

complianceCode

Eigenschaft

complianceCode:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get complianceCode():String
public function set complianceCode(value:String):void

currentStage

Eigenschaft

currentStage:int

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get currentStage():int
public function set currentStage(value:int):void

customAttributes

Eigenschaft

customAttributes:ArrayCollection

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a list of custom attributes.

Implementierung
public function get customAttributes():ArrayCollection
public function set customAttributes(value:ArrayCollection):void

Verwandte API-Elemente

CustomAttribute

initiator

Eigenschaft

initiator:Initiator

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the initiator of the review.

Implementierung
public function get initiator():Initiator
public function set initiator(value:Initiator):void

purpose

Eigenschaft

purpose:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies a purpose for the review provided by the user.

Implementierung
public function get purpose():String
public function set purpose(value:String):void

reviewId

Eigenschaft

reviewId:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get reviewId():String
public function set reviewId(value:String):void

revision

Eigenschaft

revision:int

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get revision():int
public function set revision(value:int):void

rtsProcessName

Eigenschaft

rtsProcessName:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the name of the process that is used to generate a review tracking sheet.

Implementierung
public function get rtsProcessName():String
public function set rtsProcessName(value:String):void

stages

Eigenschaft

stages:StageCollection

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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).

Implementierung
public function get stages():StageCollection
public function set stages(value:StageCollection):void

status

Eigenschaft

status:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the status of the Managed Review and Approval building block process.

Der Standardwert ist ReviewStatus.ONGOING.

Implementierung
public function get status():String
public function set status(value:String):void

Verwandte API-Elemente

com.adobe.livecycle.rca.model.constant.ReviewStatus

straightThroughProcessing

Eigenschaft

straightThroughProcessing:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Der Standardwert ist true.

Implementierung
public function get straightThroughProcessing():Boolean
public function set straightThroughProcessing(value:Boolean):void

supportingDocuments

Eigenschaft

supportingDocuments:DocumentCollection

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get supportingDocuments():DocumentCollection
public function set supportingDocuments(value:DocumentCollection):void

templateAuthor

Eigenschaft

templateAuthor:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the author of the template that was used to initiate a review.

Implementierung
public function get templateAuthor():String
public function set templateAuthor(value:String):void

templateDesc

Eigenschaft

templateDesc:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the description of the template that is used to initiate a review.

Implementierung
public function get templateDesc():String
public function set templateDesc(value:String):void

templateIsActive

Eigenschaft

templateIsActive:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies whether the template that is used to initiate a review is an active process.

Implementierung
public function get templateIsActive():Boolean
public function set templateIsActive(value:Boolean):void

templateName

Eigenschaft

templateName:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the name of the template that is used to initiate a review.

Implementierung
public function get templateName():String
public function set templateName(value:String):void

title

Eigenschaft

title:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

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.

Implementierung
public function get title():String
public function set title(value:String):void

type

Eigenschaft

type:String

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Specifies the type of review.

Der Standardwert ist ReviewType.REGULATED_REVIEW.

Implementierung
public function get type():String
public function set type(value:String):void

Verwandte API-Elemente

ReviewType

Konstruktordetails

()

Konstruktor

public function ReviewContext()

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Review, Commenting, and Approval“ 9.5

Laufzeitversionen:

Flash Player 9, Flash Player 10, AIR (unsupported)

Constructor.

Methodendetails

addEventListener

()

Methode

 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).

Parameter

	`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: `function(evt:Event):void` The function can have any name.

	`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 `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

Methode

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.

Parameter

event:Event — The event object dispatched into the event flow.

Rückgabewerte

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

Methode

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.

Parameter

type:String — The type of event.

Rückgabewerte

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

Methode

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.

Parameter

	`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

()

Methode

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.

Parameter

type:String — The type of event.

Rückgabewerte

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Rechtliche Hinweise | Onlinedatenschutzerklärung

ReviewContext - AS3 Review, Commenting, and Approval

Klassen x

additionalMetaData

arsProcessName

auditLevel

commentServerPath

commentVisibility

complianceCode

currentStage

customAttributes

initiator

purpose

reviewId

revision

rtsProcessName

stages

status

straightThroughProcessing

supportingDocuments

templateAuthor

templateDesc

templateIsActive

templateName

title

type

ReviewContext

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger