Guida di riferimento di ActionScript® 3.0 per la piattaforma Adobe® Flash®
Home  |  Nascondi elenco pacchetti e classi |  Pacchetti  |  Classi  |  Novità  |  Indice  |  Appendici  |  Perché in inglese?
Filtri: Recupero dati dal server...
Recupero dati dal server...
com.adobe.solutions.rca.domain.impl 

Participant  - AS3 Review, Commenting, and Approval

Pacchettocom.adobe.solutions.rca.domain.impl
Classepublic class Participant
EreditarietàParticipant Inheritance Object
Implementa IParticipant, IEventDispatcher
Sottoclassi Initiator, StageParticipant

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10.0
Versioni runtime: Flash Player 10.2, AIR (unsupported)

This class defines a participant in a review workflow.



Proprietà pubbliche
 ProprietàDefinito da
  additionalMetadata : String
This property can be used to store additional metadata, while extending the application.
Participant
  assignedTo : IMemberCollection
[sola lettura] Reference to the member collection to which this member is assigned.
Participant
  canonicalName : String
[sola lettura] CanonicalName of the member as defined in Document Server User Management.
Participant
  completedBy : String
This property stores the reference to the user who completed the task assigned to a participant.
Participant
  completedFromIP : String
This property holds the IP from which a task assigned to a participant is completed.
Participant
 Inheritedconstructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.
Object
  disposition : String
Current disposition of a participant, if any.
Participant
  domainName : String
[sola lettura] Domain name of the member as defined in Document Server User Management.
Participant
  email : String
[sola lettura] Email of the member.
Participant
  finalComments : String
The final comments made by the participant after reviewing or approving a document.
Participant
  id : String
[sola lettura] Unique identifier for a participant.
Participant
  name : String
[sola lettura] Name of the member.
Participant
  reviewContext : IReviewContext
The details of the review version of which a participant is a part.
Participant
  role : String
[sola lettura] Role of the member in the workflow.
Participant
  status : String
Current status of a participant.
Participant
  title : String
[sola lettura] Title of the member in the workflow.
Participant
  type : String
[sola lettura]
Participant
  user : IUser
The user object for a participant.
Participant
  vo : ParticipantVO
The Value Object for a participant.
Participant
Metodi pubblici
 MetodoDefinito da
  
The constructor for Participant class.
Participant
  
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.
Participant
  
Dispatches an event into the event flow.
Participant
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Participant
 Inherited
Indica se per un oggetto è definita una proprietà specifica.
Object
 Inherited
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.
Object
 Inherited
Indica se la proprietà specificata esiste ed è enumerabile.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Participant
 Inherited
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.
Object
 Inherited
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.
Object
 Inherited
Restituisce la rappresentazione in formato stringa dell'oggetto specificato.
Object
 Inherited
Restituisce il valore di base dell'oggetto specificato.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Participant
Descrizione delle proprietà

additionalMetadata

proprietà
additionalMetadata:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

This property can be used to store additional metadata, while extending the application.



Implementazione
    public function get additionalMetadata():String
    public function set additionalMetadata(value:String):void

assignedTo

proprietà 
assignedTo:IMemberCollection  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Reference to the member collection to which this member is assigned.



Implementazione
    public function get assignedTo():IMemberCollection

canonicalName

proprietà 
canonicalName:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

CanonicalName of the member as defined in Document Server User Management. The combination of canonicalName and domainName are used to uniquely identify a user.



Implementazione
    public function get canonicalName():String

completedBy

proprietà 
completedBy:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

This property stores the reference to the user who completed the task assigned to a participant.



Implementazione
    public function get completedBy():String
    public function set completedBy(value:String):void

completedFromIP

proprietà 
completedFromIP:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

This property holds the IP from which a task assigned to a participant is completed.



Implementazione
    public function get completedFromIP():String
    public function set completedFromIP(value:String):void

disposition

proprietà 
disposition:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Current disposition of a participant, if any.



Implementazione
    public function get disposition():String
    public function set disposition(value:String):void

domainName

proprietà 
domainName:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Domain name of the member as defined in Document Server User Management. The combination of canonicalName and domainName are used to uniquely identify a user.



Implementazione
    public function get domainName():String

email

proprietà 
email:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Email of the member.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento userUpdated .



Implementazione
    public function get email():String

finalComments

proprietà 
finalComments:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

The final comments made by the participant after reviewing or approving a document.



Implementazione
    public function get finalComments():String
    public function set finalComments(value:String):void

id

proprietà 
id:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Unique identifier for a participant.



Implementazione
    public function get id():String

name

proprietà 
name:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Name of the member.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento userUpdated .



Implementazione
    public function get name():String

reviewContext

proprietà 
reviewContext:IReviewContext

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

The details of the review version of which a participant is a part.



Implementazione
    public function get reviewContext():IReviewContext
    public function set reviewContext(value:IReviewContext):void

role

proprietà 
role:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Role of the member in the workflow.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento userUpdated .



Implementazione
    public function get role():String

status

proprietà 
status:String

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Current status of a participant.



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

title

proprietà 
title:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Title of the member in the workflow.



Implementazione
    public function get title():String

type

proprietà 
type:String  [sola lettura]

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento userUpdated .



Implementazione
    public function get type():String

user

proprietà 
user:IUser

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

The user object for a participant.



Implementazione
    public function get user():IUser
    public function set user(value:IUser):void

vo

proprietà 
vo:ParticipantVO

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10
Versioni runtime: Flash Player 10.2, AIR (unsupported)

The Value Object for a participant.



Implementazione
    public function get vo():ParticipantVO
    public function set vo(value:ParticipantVO):void
Descrizione della funzione di costruzione

Participant

()Funzione di costruzione
public function Participant(value:ParticipantVO)

Versione linguaggio: ActionScript 3.0
Versione prodotto: Blocco costitutivo Review, Commenting, and Approval 10.0
Versioni runtime: Flash Player 10.2, AIR (unsupported)

The constructor for Participant class.

Parametri
value:ParticipantVO — Participant value object.
Descrizione dei metodi

addEventListener

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

Parametri

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

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

Parametri

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

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

hasEventListener

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

Parametri

type:String — The type of event.

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

removeEventListener

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

Parametri

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

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

Parametri

type:String — The type of event.

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




[ X ]Perché in inglese?
Il contenuto della Guida di riferimento di ActionScript 3.0 appare in inglese

Non tutte le parti della Guida di riferimento di ActionScript 3.0 sono tradotte in tutte le lingue. Quando un elemento del linguaggio non è tradotto, viene riportato in inglese. Ad esempio, la classe ga.controls.HelpBox non è tradotta in nessuna lingua. Pertanto, nella versione italiana della guida di riferimento, la descrizione della classe ga.controls.HelpBox è riportata in inglese.