com.adobe.livecycle.assetmanager.client.model.AssetPropertyDescriptor - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	com.adobe.livecycle.assetmanager.client.model
Class	public class AssetPropertyDescriptor
Inheritance	AssetPropertyDescriptor Object
Implements	IEventDispatcher

Deprecated: Deprecated

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Holds the metadata associated with the instance of the asset property. If the instance represents a complex or composite property, this class also contains a list of child property descriptors.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		assetExtendedProperty : Boolean [read-only] Specifies whether this instance of the property is an extended property of the original asset or value object.	AssetPropertyDescriptor
		assetPropertyType : String Specifies whether the asset property type is extended or core.	AssetPropertyDescriptor
		basicSearchEnabled : Boolean Specifies whether basic search is enabled for the property.	AssetPropertyDescriptor
		childDescriptors : IList Specifies a collection of child property descriptors for this property, if it is a composite property.	AssetPropertyDescriptor
		columnOrder : Number Specifies the display column order of the property in the Search Results Viewer.	AssetPropertyDescriptor
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		customItemRenderer : String Specifies the fully qualified class name of a custom item renderer for displaying this property in the Search Results Viewer.	AssetPropertyDescriptor
		displayName : String Specifies the display name of the property.	AssetPropertyDescriptor
		displayPattern : String Specifies the display pattern.	AssetPropertyDescriptor
		extendedProperties : Object Specifies a map of extended properties that are associated with this property.	AssetPropertyDescriptor
		extendedPropertyPath : String Specifies whether this property is an extended value object property.	AssetPropertyDescriptor
		maxValue : Number Specifies the maximum property value.	AssetPropertyDescriptor
		minValue : Number Specifies a minimum property value.	AssetPropertyDescriptor
		name : String Specifies the name of the asset property.	AssetPropertyDescriptor
		optionList : IList Specifies an option list of data-label pairs.	AssetPropertyDescriptor
		path : String Specifies the path of the asset property.	AssetPropertyDescriptor
		propertyType : String Specifies whether the property is a composite or simple property.	AssetPropertyDescriptor
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		searchable : Boolean Specifies whether the property can be searched.	AssetPropertyDescriptor
		searchPath : String Specifies the path of the property that is used in search queries.	AssetPropertyDescriptor
		searchRenderer : String Specifies the fully qualified name for the custom search renderer of the property.	AssetPropertyDescriptor
		searchRendererOrder : Number Specifies the order of the search renderer of this property in the Search Results Viewer.	AssetPropertyDescriptor
		visible : Boolean Specifies whether the property is displayed in the Manage Assets UI Search Results Viewer.	AssetPropertyDescriptor

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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.	AssetPropertyDescriptor
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	AssetPropertyDescriptor
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	AssetPropertyDescriptor
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isComposite():Boolean Specifies whether the property is a composite property that has child properties.	AssetPropertyDescriptor
		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
		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.	AssetPropertyDescriptor
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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.	AssetPropertyDescriptor

Public Constants

	Constant		Defined By
		ASSET_EXTENDED_PROPERTY : String = "extended" [static] Specifies that the property is extended.	AssetPropertyDescriptor

Property Detail

assetExtendedProperty

property

assetExtendedProperty:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether this instance of the property is an extended property of the original asset or value object.

Implementation
public function get assetExtendedProperty():Boolean

assetPropertyType

property

assetPropertyType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the asset property type is extended or core.

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

basicSearchEnabled

property

basicSearchEnabled:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether basic search is enabled for the property. There can be only one such property for each asset type.

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

childDescriptors

property

childDescriptors:IList

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies a collection of child property descriptors for this property, if it is a composite property.

Implementation
public function get childDescriptors():IList
public function set childDescriptors(value:IList):void

columnOrder

property

columnOrder:Number

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the display column order of the property in the Search Results Viewer.

Implementation
public function get columnOrder():Number
public function set columnOrder(value:Number):void

customItemRenderer

property

customItemRenderer:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the fully qualified class name of a custom item renderer for displaying this property in the Search Results Viewer. This class should implement mx.core.IDataRenderer interface.

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

displayName

property

displayName:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the display name of the property.

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

displayPattern

property

displayPattern:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the display pattern. Used if the property is of type date.

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

extendedProperties

property

extendedProperties:Object

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies a map of extended properties that are associated with this property.

Implementation
public function get extendedProperties():Object
public function set extendedProperties(value:Object):void

extendedPropertyPath

property

extendedPropertyPath:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether this property is an extended value object property. It also specifies the path of this property in the value object.

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

maxValue

property

maxValue:Number

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the maximum property value. Used if the property is numeric.

Implementation
public function get maxValue():Number
public function set maxValue(value:Number):void

minValue

property

minValue:Number

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies a minimum property value. Used if the property is numeric.

Implementation
public function get minValue():Number
public function set minValue(value:Number):void

name

property

name:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the name of the asset property.

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

optionList

property

optionList:IList

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies an option list of data-label pairs.

Implementation
public function get optionList():IList
public function set optionList(value:IList):void

path

property

path:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the path of the asset property.

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

propertyType

property

propertyType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the property is a composite or simple property.

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

searchable

property

searchable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the property can be searched.

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

searchPath

property

searchPath:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the path of the property that is used in search queries. If this property is empty, path is used as searchPath.

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

searchRenderer

property

searchRenderer:String

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the fully qualified name for the custom search renderer of the property. The class should extend com.adobe.livecycle.assetmanager.client.view.search.ISearchUIControl.

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

searchRendererOrder

property

searchRendererOrder:Number

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies the order of the search renderer of this property in the Search Results Viewer.

Implementation
public function get searchRendererOrder():Number
public function set searchRendererOrder(value:Number):void

visible

property

visible:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the property is displayed in the Manage Assets UI Search Results Viewer.

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

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.

isComposite

()

method

public function isComposite():Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies whether the property is a composite property that has child properties.

Returns

Boolean —

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.

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.

Constant Detail

ASSET_EXTENDED_PROPERTY

Constant

public static const ASSET_EXTENDED_PROPERTY:String = "extended"

Language Version:

ActionScript 3.0

Product Version:

Asset Manager Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Specifies that the property is extended.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

assetExtendedProperty

assetPropertyType

basicSearchEnabled

childDescriptors

columnOrder

customItemRenderer

displayName

displayPattern

extendedProperties

extendedPropertyPath

maxValue

minValue

name

optionList

path

propertyType

searchable

searchPath

searchRenderer

searchRendererOrder

visible

addEventListener

dispatchEvent

hasEventListener

isComposite

removeEventListener

willTrigger

ASSET_EXTENDED_PROPERTY