DocumentCollection

Package	com.adobe.livecycle.rca.model.document
Class	public class DocumentCollection
Inheritance	DocumentCollection ArrayCollection ListCollectionView Proxy

Deprecated since Review, Commenting, and Approval 10: Please Use com.adobe.solutions.rca.vo.ReviewContextVO.supportingDocumentList

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 that SupportingDocument objects are added to a collection.

Default MXML Propertysource

Public Properties

	Property		Defined By
		filterFunction : Function A function that the view will use to eliminate items that do not match the function's criteria.	ListCollectionView
		length : int [read-only] The number of items in this view.	ListCollectionView
		list : IList The IList that this collection view wraps.	ListCollectionView
		sort : ISort The ISort that will be applied to the ICollectionView.	ListCollectionView
		source : Array The source of data in the ArrayCollection.	ArrayCollection

Protected Properties

	Property		Defined By
		localIndex : Array When the view is sorted or filtered the localIndex property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order.	ListCollectionView

Public Methods

	Method		Defined By
		DocumentCollection(source:Array = null) Constructor.	DocumentCollection
		addAll(addList:IList):void Adds a list of items to the current list, placing them at the end of the list in the order they are passed.	ListCollectionView
		addAllAt(addList:IList, index:int):void Adds a list of items to the current list, placing them at the position index passed in to the function.	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ListCollectionView
		addItem(item:Object):void [override] Overrides the addItem() method for ArrayCollection.	DocumentCollection
		addItemAt(item:Object, index:int):void [override] Overrides the addItemAt() method for ArrayCollection.	DocumentCollection
		addSupportingDocument(doc:SupportingDocument):void Adds items of type SupportingDocument to the collection.	DocumentCollection
		addSupportingDocumentAt(doc:SupportingDocument, index:int):void Adds items of type SupportingDocument to the collection.	DocumentCollection
		contains(item:Object):Boolean Returns whether the view contains the specified object.	ListCollectionView
		createCursor():IViewCursor Creates a new IViewCursor that works with this view.	ListCollectionView
		disableAutoUpdate():void Prevents changes to the collection itself and items within the collection from being dispatched by the view.	ListCollectionView
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ListCollectionView
		enableAutoUpdate():void Enables auto-updating.	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object Gets the item at the specified index.	ListCollectionView
		getItemIndex(item:Object):int Returns the index of the item if it is in the list such that getItemAt(index) == item.	ListCollectionView
		getSupportingDocumentAt(index:int):SupportingDocument Returns a SupportingDocument type object instead of a generic object.	DocumentCollection
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ListCollectionView
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Notifies the view that an item has been updated.	ListCollectionView
		refresh():Boolean Applies the sort and filter to the view.	ListCollectionView
		removeAll():void Remove all items from the list.	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ListCollectionView
		removeItemAt(index:int):Object Removes the item at the specified index and returns it.	ListCollectionView
		setItemAt(item:Object, index:int):Object Places the item at the specified index.	ListCollectionView
		toArray():Array Returns an Array that is populated in the same order as the IList implementation.	ListCollectionView
		toString():String Prints the contents of this view to a string and returns it.	ListCollectionView
		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.	ListCollectionView

Events

Click for more information on events

	Event		Summary	Defined By
		collectionChange	Dispatched when the ICollectionView has been updated in some way.	ListCollectionView

Constructor Detail

DocumentCollection

()

Constructor

public function DocumentCollection(source:Array = null)

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)

Constructor.

Parameters

source:Array (default = null)

Method Detail

addItem

()

method

override public function addItem(item:Object):void

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)

Overrides the addItem() method for ArrayCollection. Adds an item only if it is of type SupportingDocument.

Parameters

item:Object

Related API Elements

SupportingDocument

addItemAt

()

method

override public function addItemAt(item:Object, index:int):void

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)

Overrides the addItemAt() method for ArrayCollection. Adds an item only if it is of type SupportingDocument.

Parameters

	`item:Object`

	`index:int`

Related API Elements

SupportingDocument

addSupportingDocument

()

method

public function addSupportingDocument(doc:SupportingDocument):void

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)

Adds items of type SupportingDocument to the collection.

Parameters

doc:SupportingDocument

Related API Elements

SupportingDocument

addSupportingDocumentAt

()

method

public function addSupportingDocumentAt(doc:SupportingDocument, index:int):void

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)

Adds items of type SupportingDocument to the collection.

Parameters

	`doc:SupportingDocument`

	`index:int`

Related API Elements

SupportingDocument

getSupportingDocumentAt

()

method

public function getSupportingDocumentAt(index:int):SupportingDocument

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)

Returns a SupportingDocument type object instead of a generic object.

Parameters

index:int

Returns

SupportingDocument

Related API Elements

SupportingDocument

Legal Notices | Online Privacy Policy

DocumentCollection - AS3 Review, Commenting, and Approval

Classes x

DocumentCollection

addItem

addItemAt

addSupportingDocument

addSupportingDocumentAt

getSupportingDocumentAt