Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
com.adobe.solutions.rca.domain.impl 

ReviewContext  - AS3 Review, Commenting, and Approval

Pacotecom.adobe.solutions.rca.domain.impl
Classepublic class ReviewContext
HerançaReviewContext Inheritance Object
Implementações IReviewContext, IEventDispatcher
Subclasses ReviewTemplate

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10.0
Versões de runtime: Flash Player 10.2, AIR (unsupported)

This class defines the review context domain object.



Propriedades públicas
 PropriedadeDefinido por
  additionalMetadata : String
Any review-specific data can be preserved in this field.
ReviewContext
  allMemberList : IList
[somente leitura] The property returns a collection of all members.
ReviewContext
  arsProcessName : String
Name of the process used to generate Approval Routing Sheet (ARS).
ReviewContext
  auditLevel : String
The level of audit associated with this review.
ReviewContext
  calculatedEndDate : Date
The endDate if the review has ended.
ReviewContext
  calculatedStartDate : Date
The startDate if the review has started.
ReviewContext
  changeDescription : String
This field is used to store the change desciption, if a review is revised.
ReviewContext
  commentServerPath : String
Server location where Adobe ® Acrobat ® stores the inline comments.
ReviewContext
  commentVisibility : String
Adobe Acrobat's inline comment visibility across stages.
ReviewContext
  complianceCode : String
Compliance code of the schedule template.
ReviewContext
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
Object
  currentRevision : Boolean
A Boolean value to decide whether this is the current revision of the review or not.
ReviewContext
  currentStage : int
Stage number in progress for this review (starts with 1).
ReviewContext
  customAttributes : IList
List of custom attributes.
ReviewContext
  endDate : Date
End date of a review.
ReviewContext
  ganttItems : ArrayCollection
[somente leitura] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.
ReviewContext
  id : String
[somente leitura] A unique identifier for this review version.
ReviewContext
  initiator : IInitiator
Initiator of a review.
ReviewContext
  invocationId : String
The ID of the invocation request when a review is initiated.
ReviewContext
  itemEndDate : Date
[somente leitura] End date of the item.
ReviewContext
  itemName : String
[somente leitura] Name of the item.
ReviewContext
  itemStartDate : Date
[somente leitura] Start date of the item.
ReviewContext
  itemState : String
[somente leitura] State of the item.
ReviewContext
  itemStatus : String
[somente leitura] Status of the item.
ReviewContext
  itemType : String
[somente leitura] Type of item.
ReviewContext
  largeThumbnail : File
Large thumbnail image of a document under review.
ReviewContext
  memberList : IList
[somente leitura] The property returns a collection of directly associated members.
ReviewContext
  nativeFileName : String
Path of the file, in the content repository, on which the review is initiated.
ReviewContext
  operationList : ArrayCollection
[somente leitura] A collection of operations that are available to a user through the context menu in the Gantt chart.
ReviewContext
  purpose : String
Review purpose.
ReviewContext
  reviewCommentingAndApproval : IReviewCommentingAndApproval
An instance of Review Commenting and Approval service for this review.
ReviewContext
  reviewId : String
A unique identifier of the review.
ReviewContext
  reviewType : String
Type of review like Regulated or Ad-hoc.
ReviewContext
  revision : int
Review revision number.
ReviewContext
  rtsProcessName : String
Name of the process used to generate Review Tracking Sheet (RTS).
ReviewContext
  showChildren : Boolean
A Boolean flag to determine if the children need to be displayed.
ReviewContext
  showParent : Boolean
A Boolean flag to determine if the parent needs to be displayed.
ReviewContext
  smallThumbnail : File
Small thumbnail image of a document under review.
ReviewContext
  stageList : IList
List of stages in a review.
ReviewContext
  startDate : Date
Start date of a review.
ReviewContext
  status : String
Review purpose.
ReviewContext
  stp : Boolean
A Boolean field to enable or disable Straight Through Processing (STP).
ReviewContext
  supportingDocumentList : IList
List of supporting documents for a review.
ReviewContext
  templateAuthor : String
Name of the schedule template author.
ReviewContext
  templateDescription : String
Description of the schedule template used to initiate this review.
ReviewContext
  title : String
Review title.
ReviewContext
  uniqueMemberList : IList
[somente leitura] The property returns a collection of unique members.
ReviewContext
  vo : ReviewContextVO
The Value Object for this review version.
ReviewContext
Métodos públicos
 MétodoDefinido por
  
The constructor for ReviewContext class.
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
  
This remote operation adds a member to the collection and submits the change to the server.
ReviewContext
  
Adds stage to the review after the last stage.
ReviewContext
  
addStageAt(stage:IStage, index:int):void
Adds stage to the review at the specified index from the beginning.
ReviewContext
  
Adds the supporting document at the end of the list of supportingDocuments for this review.
ReviewContext
  
Adds the supporting document at the index in the list of supportingDocuments for this review.
ReviewContext
  
Populates the calculatedStartDate and calculatedEndDate fields.
ReviewContext
  
Clears ID for a reviewContext object for persisting it at another location in the repository.
ReviewContext
  
Dispatches an event into the event flow.
ReviewContext
  
Returns an asset archive for this review.
ReviewContext
  
Returns largeThumbnail for this review version.
ReviewContext
  
Returns the original file submitted for review.
ReviewContext
  
Returns the review context value object for this review.
ReviewContext
  
Returns the review document for this review.
ReviewContext
  
Returns smallThumbnail for this review version.
ReviewContext
  
A Boolean function to determine if the item has displayable children.
ReviewContext
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ReviewContext
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
  
Removes all stages from a review.
ReviewContext
  
Removes all supporting documents from the list of supportingDocuments for this review.
ReviewContext
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
ReviewContext
  
This remote operation removes a member from the collection and submits the change to the server.
ReviewContext
  
Removes a stage at the specified index from the beginning of the review.
ReviewContext
  
Removes a supporting document at the index from the list of supportingDocuments for this review.
ReviewContext
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
  
This remote operation updates the tile of a member present in collection and submits the change to the server.
ReviewContext
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ReviewContext
Detalhes da propriedade

additionalMetadata

propriedade
additionalMetadata:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Any review-specific data can be preserved in this field.



Implementação
    public function get additionalMetadata():String
    public function set additionalMetadata(value:String):void

allMemberList

propriedade 
allMemberList:IList  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The property returns a collection of all members. It takes into consideration any child objects that may be of type IMemberCollection.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento memberListChanged .



Implementação
    public function get allMemberList():IList

arsProcessName

propriedade 
arsProcessName:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Name of the process used to generate Approval Routing Sheet (ARS).



Implementação
    public function get arsProcessName():String
    public function set arsProcessName(value:String):void

auditLevel

propriedade 
auditLevel:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The level of audit associated with this review.



Implementação
    public function get auditLevel():String
    public function set auditLevel(value:String):void

calculatedEndDate

propriedade 
calculatedEndDate:Date

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The endDate if the review has ended. Otherwise the expected ended date.



Implementação
    public function get calculatedEndDate():Date
    public function set calculatedEndDate(value:Date):void

calculatedStartDate

propriedade 
calculatedStartDate:Date

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The startDate if the review has started. Otherwise the expected start date.



Implementação
    public function get calculatedStartDate():Date
    public function set calculatedStartDate(value:Date):void

changeDescription

propriedade 
changeDescription:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

This field is used to store the change desciption, if a review is revised.



Implementação
    public function get changeDescription():String
    public function set changeDescription(value:String):void

commentServerPath

propriedade 
commentServerPath:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Server location where Adobe ® Acrobat ® stores the inline comments.



Implementação
    public function get commentServerPath():String
    public function set commentServerPath(value:String):void

commentVisibility

propriedade 
commentVisibility:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Adobe Acrobat's inline comment visibility across stages.



Implementação
    public function get commentVisibility():String
    public function set commentVisibility(value:String):void

complianceCode

propriedade 
complianceCode:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Compliance code of the schedule template.



Implementação
    public function get complianceCode():String
    public function set complianceCode(value:String):void

currentRevision

propriedade 
currentRevision:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A Boolean value to decide whether this is the current revision of the review or not.



Implementação
    public function get currentRevision():Boolean
    public function set currentRevision(value:Boolean):void

currentStage

propriedade 
currentStage:int

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Stage number in progress for this review (starts with 1).



Implementação
    public function get currentStage():int
    public function set currentStage(value:int):void

customAttributes

propriedade 
customAttributes:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

List of custom attributes.



Implementação
    public function get customAttributes():IList
    public function set customAttributes(value:IList):void

endDate

propriedade 
endDate:Date

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

End date of a review.



Implementação
    public function get endDate():Date
    public function set endDate(value:Date):void

ganttItems

propriedade 
ganttItems:ArrayCollection  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento ganttItemsChanged .



Implementação
    public function get ganttItems():ArrayCollection

id

propriedade 
id:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A unique identifier for this review version.



Implementação
    public function get id():String

initiator

propriedade 
initiator:IInitiator

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Initiator of a review.



Implementação
    public function get initiator():IInitiator
    public function set initiator(value:IInitiator):void

invocationId

propriedade 
invocationId:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The ID of the invocation request when a review is initiated.



Implementação
    public function get invocationId():String
    public function set invocationId(value:String):void

itemEndDate

propriedade 
itemEndDate:Date  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

End date of the item.



Implementação
    public function get itemEndDate():Date

itemName

propriedade 
itemName:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Name of the item.



Implementação
    public function get itemName():String

itemStartDate

propriedade 
itemStartDate:Date  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Start date of the item.



Implementação
    public function get itemStartDate():Date

itemState

propriedade 
itemState:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

State of the item.



Implementação
    public function get itemState():String

itemStatus

propriedade 
itemStatus:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Status of the item.



Implementação
    public function get itemStatus():String

itemType

propriedade 
itemType:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Type of item.



Implementação
    public function get itemType():String

largeThumbnail

propriedade 
largeThumbnail:File

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Large thumbnail image of a document under review.



Implementação
    public function get largeThumbnail():File
    public function set largeThumbnail(value:File):void

memberList

propriedade 
memberList:IList  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The property returns a collection of directly associated members.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento memberListChanged .



Implementação
    public function get memberList():IList

nativeFileName

propriedade 
nativeFileName:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Path of the file, in the content repository, on which the review is initiated.



Implementação
    public function get nativeFileName():String
    public function set nativeFileName(value:String):void

operationList

propriedade 
operationList:ArrayCollection  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A collection of operations that are available to a user through the context menu in the Gantt chart.



Implementação
    public function get operationList():ArrayCollection

purpose

propriedade 
purpose:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Review purpose.



Implementação
    public function get purpose():String
    public function set purpose(value:String):void

reviewCommentingAndApproval

propriedade 
reviewCommentingAndApproval:IReviewCommentingAndApproval

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

An instance of Review Commenting and Approval service for this review.



Implementação
    public function get reviewCommentingAndApproval():IReviewCommentingAndApproval
    public function set reviewCommentingAndApproval(value:IReviewCommentingAndApproval):void

reviewId

propriedade 
reviewId:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A unique identifier of the review.



Implementação
    public function get reviewId():String
    public function set reviewId(value:String):void

reviewType

propriedade 
reviewType:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Type of review like Regulated or Ad-hoc.



Implementação
    public function get reviewType():String
    public function set reviewType(value:String):void

revision

propriedade 
revision:int

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Review revision number.



Implementação
    public function get revision():int
    public function set revision(value:int):void

rtsProcessName

propriedade 
rtsProcessName:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Name of the process used to generate Review Tracking Sheet (RTS).



Implementação
    public function get rtsProcessName():String
    public function set rtsProcessName(value:String):void

showChildren

propriedade 
showChildren:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the children need to be displayed.



Implementação
    public function get showChildren():Boolean
    public function set showChildren(value:Boolean):void

showParent

propriedade 
showParent:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the parent needs to be displayed.



Implementação
    public function get showParent():Boolean
    public function set showParent(value:Boolean):void

smallThumbnail

propriedade 
smallThumbnail:File

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Small thumbnail image of a document under review.



Implementação
    public function get smallThumbnail():File
    public function set smallThumbnail(value:File):void

stageList

propriedade 
stageList:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

List of stages in a review.



Implementação
    public function get stageList():IList
    public function set stageList(value:IList):void

startDate

propriedade 
startDate:Date

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Start date of a review.



Implementação
    public function get startDate():Date
    public function set startDate(value:Date):void

status

propriedade 
status:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Review purpose.



Implementação
    public function get status():String
    public function set status(value:String):void

stp

propriedade 
stp:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A Boolean field to enable or disable Straight Through Processing (STP).



Implementação
    public function get stp():Boolean
    public function set stp(value:Boolean):void

supportingDocumentList

propriedade 
supportingDocumentList:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

List of supporting documents for a review.



Implementação
    public function get supportingDocumentList():IList
    public function set supportingDocumentList(value:IList):void

templateAuthor

propriedade 
templateAuthor:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Name of the schedule template author.



Implementação
    public function get templateAuthor():String
    public function set templateAuthor(value:String):void

templateDescription

propriedade 
templateDescription:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Description of the schedule template used to initiate this review.



Implementação
    public function get templateDescription():String
    public function set templateDescription(value:String):void

title

propriedade 
title:String

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Review title.



Implementação
    public function get title():String
    public function set title(value:String):void

uniqueMemberList

propriedade 
uniqueMemberList:IList  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The property returns a collection of unique members.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento memberListChanged .



Implementação
    public function get uniqueMemberList():IList

vo

propriedade 
vo:ReviewContextVO

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The Value Object for this review version.



Implementação
    public function get vo():ReviewContextVO
    public function set vo(value:ReviewContextVO):void
Detalhes do construtor

ReviewContext

()Construtor
public function ReviewContext(value:ReviewContextVO = null)

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10.0
Versões de runtime: Flash Player 10.2, AIR (unsupported)

The constructor for ReviewContext class.

Parâmetros
value:ReviewContextVO (default = null) — Review context value object.
Detalhes do método

addEventListener

()método
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).

Parâmetros

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.

addMemberAndSave

()método 
public function addMemberAndSave(member:IMember):mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

This remote operation adds a member to the collection and submits the change to the server.

Parâmetros

member:IMember — The member to be added to member collection.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

addStage

()método 
public function addStage(stage:IStage):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Adds stage to the review after the last stage.

Parâmetros

stage:IStageStage instance that needs to be added.

addStageAt

()método 
public function addStageAt(stage:IStage, index:int):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Adds stage to the review at the specified index from the beginning.

Parâmetros

stage:IStageStage instance that needs to be added.
 
index:int — Index at which this stage needs to be added.

addSupportingDocument

()método 
public function addSupportingDocument(doc:ISupportingDocument):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Adds the supporting document at the end of the list of supportingDocuments for this review.

Parâmetros

doc:ISupportingDocument — Supporting document that needs to be added.

addSupportingDocumentAt

()método 
public function addSupportingDocumentAt(doc:ISupportingDocument, index:int):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Adds the supporting document at the index in the list of supportingDocuments for this review.

Parâmetros

doc:ISupportingDocument — Supporting document that needs to be added.
 
index:int — Index at which the supporting document needs to be added.

calculateDates

()método 
public function calculateDates():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Populates the calculatedStartDate and calculatedEndDate fields.

clearIds

()método 
public function clearIds():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Clears ID for a reviewContext object for persisting it at another location in the repository.

dispatchEvent

()método 
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.

Parâmetros

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

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

fetchAssetArchive

()método 
public function fetchAssetArchive():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns an asset archive for this review.

Retorna
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains the asset archive for this review.

fetchLargeThumbnail

()método 
public function fetchLargeThumbnail():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns largeThumbnail for this review version.

Retorna
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains largeThumbnail for this review version.

fetchNativeDocument

()método 
public function fetchNativeDocument():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns the original file submitted for review.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains original file submitted for review.

fetchReviewContext

()método 
public function fetchReviewContext():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns the review context value object for this review.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review context value object for this review.

fetchReviewDocument

()método 
public function fetchReviewDocument():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns the review document for this review.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review document for this review.

fetchSmallThumbnail

()método 
public function fetchSmallThumbnail():mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Returns smallThumbnail for this review version.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains smallThumbnail for this review version.

hasChildren

()método 
public function hasChildren():Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

A Boolean function to determine if the item has displayable children.

Retorna
Boolean — It returns a True value if there are displayable children.

hasEventListener

()método 
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.

Parâmetros

type:String — The type of event.

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

removeAllStages

()método 
public function removeAllStages():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Removes all stages from a review.

removeAllSupportingDocument

()método 
public function removeAllSupportingDocument():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Removes all supporting documents from the list of supportingDocuments for this review.

removeEventListener

()método 
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.

Parâmetros

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.

removeMemberAndSave

()método 
public function removeMemberAndSave(member:IMember):mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

This remote operation removes a member from the collection and submits the change to the server.

Parâmetros

member:IMember — The member to be removed from member collection.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeStageAt

()método 
public function removeStageAt(index:int):IStage

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Removes a stage at the specified index from the beginning of the review. Returns the removed stage.

Parâmetros

index:int — The index of the stage that needs to be removed.

Retorna
IStageStage instance that has been removed.

removeSupportingDocumentAt

()método 
public function removeSupportingDocumentAt(index:int):ISupportingDocument

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

Removes a supporting document at the index from the list of supportingDocuments for this review.

Parâmetros

index:int — Index of the supporting document that needs to be removed.

Retorna
ISupportingDocument — Supporting document that has been removed.

updateTitleAndSave

()método 
public function updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken

Versão da linguagem: ActionScript 3.0
Versão de produto: Review, Commenting, and Approval Building Block 10
Versões de runtime: Flash Player 10.2, AIR (unsupported)

This remote operation updates the tile of a member present in collection and submits the change to the server.

Parâmetros

member:IMember — The member to be removed from member collection.
 
title:String — The title of the member.

Retorna
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

willTrigger

()método 
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.

Parâmetros

type:String — The type of event.

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




[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.