ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.rca.model.stage 

AbstractStage  - AS3 Review, Commenting, and Approval
Packagecom.adobe.livecycle.rca.model.stage
Classpublic class AbstractStage
InheritanceAbstractStage Inheritance Object
Implements IEventDispatcher
Subclasses ApprovalStage, ReviewStage
Deprecated since Review, Commenting, and Approval 10: Please Use com.adobe.solutions.rca.vo.ReviewStageVO

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)

Defines the basic properties of a stage.


Public Properties
 PropertyDefined By
  additionalMetaData : String
Stores additional metadata when the application is extended.
AbstractStage
  assignTaskToInitiatorProcess : String
Specifies a process that is used to override the default AsignTaskToInitiator process.
AbstractStage
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  disposition : String
Specifies a custom status for the stage.
AbstractStage
  duration : int
Specifies the time period after which the stage expires.
AbstractStage
  durationUnit : String
Specifies the unit for the duration field.
AbstractStage
  endDate : Date
Specifies the end date of the stage.
AbstractStage
  moderators : ModeratorCollection
Specifies a collection of moderators for this stage.
AbstractStage
  name : String
Specifies the name of the stage.
AbstractStage
  nonExpiringStage : Boolean
Specifies the behavior of the stage when it has expired.
AbstractStage
  postProcessHook : String
Specifies a short-lived process that is executed after the stage has ended.
AbstractStage
  preProcessHook : String
Specifies a short-lived process that is executed before the stage starts.
AbstractStage
  reminders : ReminderCollection
Specifies a collection of reminders associated with this stage.
AbstractStage
  startDate : Date
Specifies the start date of the stage.
AbstractStage
  status : String
Specifies the status of the stage.
AbstractStage
  taskType : String
Specifies how tasks are delivered to participants.
AbstractStage
  type : String
Specifies the type of stage.
AbstractStage
  waitForExpiry : Boolean
If the value is true, the stage is not marked complete until the end of the specified duration, even if all the stage participants have completed their tasks.
AbstractStage
Public Methods
 MethodDefined By
  
AbstractStage(self:AbstractStage)
This constructor function cannot be called directly because this is an abstract class.
AbstractStage
  
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.
AbstractStage
  
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
AbstractStage
  
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
AbstractStage
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
AbstractStage
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
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.
AbstractStage
Property Detail

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)

Stores additional metadata when the application is extended.



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

assignTaskToInitiatorProcess

property 
assignTaskToInitiatorProcess: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 process that is used to override the default AsignTaskToInitiator process. This process should match the signature of the default process. In addition, it is only executed if the taskType property is CUSTOM.



Implementation
    public function get assignTaskToInitiatorProcess():String
    public function set assignTaskToInitiatorProcess(value:String):void

Related API Elements

com.adobe.livecycle.rca.model.constant.TaskTypes

disposition

property 
disposition: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 custom status for the stage.



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

duration

property 
duration: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 time period after which the stage expires. It is specified as an integer.



Implementation
    public function get duration():int
    public function set duration(value:int):void

durationUnit

property 
durationUnit: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 unit for the duration field. For example, if the duration field value is 70 and the duration unit is MINUTES, then the actual duration is 1 hour and 10 minutes. Due to performance constraints, the minimum duration is 10 minutes. A duration of less than 10 minutes defaults to 10 minutes.

The default value is DurationUnit.DAYS.



Implementation
    public function get durationUnit():String
    public function set durationUnit(value:String):void

Related API Elements

DurationUnit

endDate

property 
endDate:Date

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 end date of the stage.



Implementation
    public function get endDate():Date
    public function set endDate(value:Date):void

moderators

property 
moderators:ModeratorCollection

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 moderators for this stage.



Implementation
    public function get moderators():ModeratorCollection
    public function set moderators(value:ModeratorCollection):void

Related API Elements

com.adobe.livecycle.rca.model.participant.ModeratorCollection

name

property 
name: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 stage.



Implementation
    public function get name():String
    public function set name(value:String):void

nonExpiringStage

property 
nonExpiringStage: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 the behavior of the stage when it has expired. If the value is true, the stage is not marked expired even if the stage duration is over and participants have not completed tasks. If the value is true, the stage is marked as expired.

The default value is false.



Implementation
    public function get nonExpiringStage():Boolean
    public function set nonExpiringStage(value:Boolean):void

Related API Elements

StageStatus

postProcessHook

property 
postProcessHook: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 short-lived process that is executed after the stage has ended.



Implementation
    public function get postProcessHook():String
    public function set postProcessHook(value:String):void

preProcessHook

property 
preProcessHook: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 short-lived process that is executed before the stage starts.



Implementation
    public function get preProcessHook():String
    public function set preProcessHook(value:String):void

reminders

property 
reminders:ReminderCollection

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 reminders associated with this stage.



Implementation
    public function get reminders():ReminderCollection
    public function set reminders(value:ReminderCollection):void

Related API Elements

com.adobe.livecycle.rca.model.reminder.ReminderCollection

startDate

property 
startDate:Date

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 start date of the stage.



Implementation
    public function get startDate():Date
    public function set startDate(value:Date):void

status

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



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

Related API Elements

StageStatus

taskType

property 
taskType: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 how tasks are delivered to participants.

The default value is TaskTypes.WORKSPACE.



Implementation
    public function get taskType():String
    public function set taskType(value:String):void

Related API Elements

com.adobe.livecycle.rca.model.constant.TaskTypes

type

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



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

Related API Elements

com.adobe.livecycle.rca.model.constant.StageTypes

waitForExpiry

property 
waitForExpiry: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)

If the value is true, the stage is not marked complete until the end of the specified duration, even if all the stage participants have completed their tasks. If the value is false, the stage is marked complete when all participants have completed their tasks.

The default value is false.



Implementation
    public function get waitForExpiry():Boolean
    public function set waitForExpiry(value:Boolean):void
Constructor Detail

AbstractStage

()Constructor
public function AbstractStage(self:AbstractStage)

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)

This constructor function cannot be called directly because this is an abstract class.

Parameters
self:AbstractStage — Specifies an AbstractStage object to create.

Throws
IllegalOperationError — Indicates an error while initializing the AbstractStage object.
Method Detail

addEventListener

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

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:

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

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

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

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

Parameters

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

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

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



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy