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

RelationEvent  - AS3 ADEP Content
Packagecom.adobe.ep.ux.content.event
Classpublic class RelationEvent
InheritanceRelationEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Custom event created to act as a holder for asset, its typeDescriptor, its relations, and a boolean flag which indicates if the asset has dependencies which cannot be published.


Public Properties
 PropertyDefined By
  assetDescriptor : com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor
Asset Type Descriptor for the above asset.
RelationEvent
  assetVO : Object
The Asset whose dependencies/relations are being searched for.
RelationEvent
 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
  hasModifiedDependency : Boolean
A boolean flag that can be set if relationships have modified dependency as well.
RelationEvent
  relationsList : IList
The List of Relations based on which Search is performed.
RelationEvent
  resultsCollection : ListCollectionView
The list of Results.
RelationEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
RelationEvent(type:String, assetVO:Object, assetDesc:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor, relationsList:IList, resultsColl:ListCollectionView, hasModifiedDependency:Boolean = false, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
RelationEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 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
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  GET_ALL_DEPENDENCIES_SEARCH : String = "getAllDependenciesSearch"
[static] Event string informing about all the assets which are related to an asset either as a related dependency or contained dependency.
RelationEvent
  GET_CONTAINED_ASSETS_SEARCH : String = "getContainedAssetsSearch"
[static] Event string informing about contained assets.
RelationEvent
  GET_RELATED_ASSETS_SEARCH : String = "getRelatedAssetsSearch"
[static] Event string informing about related assets.
RelationEvent
Property Detail

assetDescriptor

property
public var assetDescriptor:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Asset Type Descriptor for the above asset.

assetVO

property 
public var assetVO:Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The Asset whose dependencies/relations are being searched for.

hasModifiedDependency

property 
public var hasModifiedDependency:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A boolean flag that can be set if relationships have modified dependency as well. This flag is used by Publish Dependencies browser.

relationsList

property 
public var relationsList:IList

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The List of Relations based on which Search is performed.

resultsCollection

property 
public var resultsCollection:ListCollectionView

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The list of Results.

Constructor Detail

RelationEvent

()Constructor
public function RelationEvent(type:String, assetVO:Object, assetDesc:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor, relationsList:IList, resultsColl:ListCollectionView, hasModifiedDependency:Boolean = false, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Constructor.

Parameters
type:String — Specifies the type of event.
 
assetVO:Object — Specifies the Asset whose dependencies or relations are being searched for.
 
assetDesc:com.adobe.ep.ux.content.model.asset:AssetTypeDescriptor — Asset Specifies the type Descriptor for the asset, which is specifies by the assetVO property.
 
relationsList:IList — Specifies the list of relations based on which the search is performed.
 
resultsColl:ListCollectionView — Specifies the list of results.
 
hasModifiedDependency:Boolean (default = false) — Specifies a boolean flag that can be set if relationships have modified dependency as well. This flag is used by Publish Dependencies browser.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
Constant Detail

GET_ALL_DEPENDENCIES_SEARCH

Constant
public static const GET_ALL_DEPENDENCIES_SEARCH:String = "getAllDependenciesSearch"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event string informing about all the assets which are related to an asset either as a related dependency or contained dependency. This is used by Publish Dependencies browser.

GET_CONTAINED_ASSETS_SEARCH

Constant 
public static const GET_CONTAINED_ASSETS_SEARCH:String = "getContainedAssetsSearch"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event string informing about contained assets. Contained Assets refer to the assets which are referred by the asset whose relationships are being obtained. This is used by Relationship browser.

GET_RELATED_ASSETS_SEARCH

Constant 
public static const GET_RELATED_ASSETS_SEARCH:String = "getRelatedAssetsSearch"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Event string informing about related assets. Related Assets are those assets which use the asset whose relationships are being obtained. This is used by Relationship browser.




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

 

Legal Notices | Online Privacy Policy