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

TemplateEvent  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.presentation.event
Classpublic class TemplateEvent
InheritanceTemplateEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This event is dispatched when an operation on a template is performed.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  isModified : Boolean
A True value of this Boolean flag indicates that the template has been modified locally.
TemplateEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  template : com.adobe.solutions.rca.domain:IReviewTemplate
This property refers to the template on which the operation is performed.
TemplateEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TemplateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
The constructor for TemplateEvent class.
TemplateEvent
  
[override] Duplicates an instance of an Event subclass.
TemplateEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  NEW_TEMPLATE_EVENT : String = "newTemplateEvent"
[static] This value indicates that a new template has been created.
TemplateEvent
  TEMPLATE_SAVED_EVENT : String = "templateSavedEvent"
[static] This value indicates that a template has been saved.
TemplateEvent
  TEMPLATE_SELECTED_EVENT : String = "templateSelectedEvent"
[static] This value indicates that an existing template has been selected.
TemplateEvent
  TEMPLATE_WORKFLOW_CANCEL_EVENT : String = "templateWorkflowCancelEvent"
[static] This value indicates that a template creation workflow has been canceled.
TemplateEvent
Property Detail

isModified

property
isModified:Boolean

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A True value of this Boolean flag indicates that the template has been modified locally.



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

template

property 
template:com.adobe.solutions.rca.domain:IReviewTemplate

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This property refers to the template on which the operation is performed.



Implementation
    public function get template():com.adobe.solutions.rca.domain:IReviewTemplate
    public function set template(value:com.adobe.solutions.rca.domain:IReviewTemplate):void
Constructor Detail

TemplateEvent

()Constructor
public function TemplateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The constructor for TemplateEvent class.

Parameters
type:String — The type of the event, accessible as Event.type.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false.
Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event) from a handler that is handling event.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

In this example, PingEvent is a subclass of Event and therefore implements its own version of clone().

     class PingEvent extends Event {
         var URL:String;
         
     public override function clone():Event {
              return new PingEvent(type, bubbles, cancelable, URL);
        }
     }
     

Returns
Event — A new Event object that is identical to the original.
Constant Detail

NEW_TEMPLATE_EVENT

Constant
public static const NEW_TEMPLATE_EVENT:String = "newTemplateEvent"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This value indicates that a new template has been created.

TEMPLATE_SAVED_EVENT

Constant 
public static const TEMPLATE_SAVED_EVENT:String = "templateSavedEvent"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This value indicates that a template has been saved.

TEMPLATE_SELECTED_EVENT

Constant 
public static const TEMPLATE_SELECTED_EVENT:String = "templateSelectedEvent"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This value indicates that an existing template has been selected.

TEMPLATE_WORKFLOW_CANCEL_EVENT

Constant 
public static const TEMPLATE_WORKFLOW_CANCEL_EVENT:String = "templateWorkflowCancelEvent"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This value indicates that a template creation workflow has been canceled.