Packagecom.adobe.portfolio.managers
Classpublic class CollectionManager
InheritanceCollectionManager Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

CollectionManager acts as a layer between navigator components and an INavigatorHost for managing the collection of files in the Portfolio. All host interactions should go through a CollectionManager instance, rather than through the INavigatorHost directly.

See also

flash.events.EventDispatcher


Public Properties
 PropertyDefined By
  applicationFont : Font
[read-only] Returns the INavigatorHost's font
CollectionManager
  applicationFontList : Array
The application's list of supported fonts
CollectionManager
  authoringMode : Boolean
A Boolean indicating whether or not the host is in authoring mode.
CollectionManager
  collectionDropManager : ICollectionDropManager
[read-only] Indicates the ICollectionDropManager exposed by the host.
CollectionManager
  colorPalette : ColorPalette
The current color palette as specified by the viewing application.
CollectionManager
  currentFolder : IAttachment
Indicates the current folder whose contents are being viewed, or null if the root is currently being viewed.
CollectionManager
  currentItems : AttachmentCollection
Indicates the items currently being viewed.
CollectionManager
  defaultFocusItem : IFocusManagerComponent
A UI component that's suitable for receiving focus by default.
CollectionManager
  embeddedFontList : Array
This function returns the array of fonts that are embedded in the portfolio.
CollectionManager
  enabled : Boolean
true if the collectionManager instance is enabled, false otherwise.
CollectionManager
  fields : Array
The array of fields displayed in the Files view of the Portfolio
CollectionManager
  fileName : String
[read-only] Returns the file name of the collection, or the empty string if the host or the collection is null.
CollectionManager
  fixedNavigatorColorPalette : Object
Indicates the fixed navigator color palette, if there is one.
CollectionManager
  focusAttachment : IAttachment
Indicates the current IAttachment considered to have focus.
CollectionManager
  focusIndex : int
Indicates the index of the current focus attachment.
CollectionManager
  host : INavigatorHost
Indicates the current INavigatorHost used to communicate with the viewing application.
CollectionManager
  instance : CollectionManager
[static] [read-only] A static instance that can be shared by Flex components.
CollectionManager
  isNavPreviewCardPreview : Boolean
Indicates whether a card is being previewing in the NavPreview component
CollectionManager
  localeLanguagePrefix : String
[read-only] Returns the prefix for the locale language, for example "en" or "fr"
CollectionManager
  newOrderedList : IList
A cache of the newly ordered list.
CollectionManager
  nextAttachment : IAttachment
Indicates the attachment following focusAttachment in the current sort order.
CollectionManager
  prevAttachment : IAttachment
Indicates the attachment following focusAttachment in the current sort order.
CollectionManager
  queueRootItems : Boolean = true
If true, then attachments will be added to the rootItems collection incrementally, rather than all at once.
CollectionManager
  rootItems : AttachmentCollection
The root items in a collection.
CollectionManager
  rootItemsJobQueue : JobQueue
[read-only] The job queue that trickles attachments into the root collection in the initialization phase of the Navigator.
CollectionManager
  selectedItems : ArrayCollection
[read-only] Indicates the currently selected items in the collection.
CollectionManager
  sort : Array
An ISort array the indicates the sort order to use.
CollectionManager
Public Methods
 MethodDefined By
  
CollectionManager(token:Object)
Constructor
CollectionManager
  
apiIsSupported(requestedVersion:Array):Boolean
This function returns true if the host supports this version of the Portfolio API; otherwise it returns false.
CollectionManager
  
deleteAttachments(attachmentArray:Array, response:Function = null):void
Deletes the set of attachments in attachmentArray from the Portfolio
CollectionManager
  
Dispatches a CollectionManagerEvent indicating that a navigator preview should be displayed.
CollectionManager
  
dispatchPartRemoved(oldPart:Object):void
Dispatches a CollectionManagerEvent indicating that a skin part has been removed.
CollectionManager
  
Returns true if Focus and Selection Events are currently suspended; false otherwise.
CollectionManager
  
Returns the index of attachment in currentItems, or -1 if currentItems does not contain attachment.
CollectionManager
  
getDefaultFontName(includeDefaultFont:Boolean):String
This function returns the name of the application's default font.
CollectionManager
  
getDirty(response:Function):void
Asynchronously returns the state of the host collection dirty flag.
CollectionManager
  
handlePreview(attachment:IAttachment):void
Invokes the appropriate preview behavior for both file and folder attachments.
CollectionManager
  
This function returns true if "Myriad Pro" font is supported, false otherwise.
CollectionManager
  
itemsAreCurrent(dataProvider:IList):Boolean
Returns true if the dataProvider for a list matches the CollectionMgr's currentItems.
CollectionManager
  
onGotoNextAttachment(evt:Event):void
An event listener that gives focus to the next attachment, if it exists.
CollectionManager
  
onGotoPreviousAttachment(evt:Event):void
An event listener that gives focus to the previous attachment, if it exists.
CollectionManager
  
permissionCheck(category:String, permission:String):Boolean
Returns true if the given category/permission combination is allowed in the host, or false otherwise.
CollectionManager
  
queryAdobeHost(app:Application):Boolean
Determines if the provided Application is an Adobe-supported host.
CollectionManager
  
setDirty():void
Marks the host collection as "dirty", which enables Save in the application UI.
CollectionManager
  
setHostFromApplication(val:INavigatorHost, app:Application):Boolean
Sets the host to be used by this class in the context of the given application.
CollectionManager
  
setSelectedItems(val:Array):void
Sets the selected items to an array of IAttachment objects.
CollectionManager
  
Calling this function tells the navigator to ignore focus changes.
CollectionManager
  
This function turns off the previously called suspension of Focus and Selection Events.
CollectionManager
  
updateColorPalette(paletteObject:Object):void
Updates the color palette used by the viewing application to be the palette passed to updateColorPalette().
CollectionManager
Protected Methods
 MethodDefined By
  
This function adjusts the state of the CollectionManager, given a new current folder.
CollectionManager
  
This function adjusts the state of the CollectionManager, given a new focused attachment.
CollectionManager
  
onCollectionPropagateEvent(event:Event):void
A listener that receives events from host.collection and propagates them using NavHostEvents.
CollectionManager
  
onCollectionPropertyChanged(evt:PropertyChangeEvent):void
A listener to handle changes to properties on host.collection.
CollectionManager
  
onCurrentFolderChanged(evt:Event):void
Listener to handle folder changes from the host.
CollectionManager
  
onCurrentItemsChange(evt:CollectionEvent):void
A listener that adjusts the current focus when currentItems changes.
CollectionManager
  
onHostPropertyChanged(event:Event):void
Listener to handle simple property changes from the host.
CollectionManager
  
Listener to propagate right-click events from the host.
CollectionManager
  
onSelectionChanged(value:Array):void
Listener to handle selection changes from the host.
CollectionManager
  
requeueList(jobUtil:JobQueue, items:IList, timerInterval:Number = 20):void
Trickles attachments into the root collection in the initialization phase of the Navigator.
CollectionManager
  
setCurrentItems(value:IList):void
Takes the IList of items passed to it and make these the list of currentItems.
CollectionManager
Events
 Event Summary Defined By
  Dispatched after various updates to the navigator host.CollectionManager
  Dispatched when a right click event is received from the host.CollectionManager
Public Constants
 ConstantDefined By
  API_VERSION_10 : Array
[static] An array representing the Portfolio API v10.0.
CollectionManager
  API_VERSION_9_5 : Array
[static] An array representing the Portfolio API v9.5.
CollectionManager
Property Detail
applicationFontproperty
applicationFont:Font  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns the INavigatorHost's font


Implementation
    public function get applicationFont():Font

See also

INavigatorHost.navigatorFont
applicationFontListproperty 
applicationFontList:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The application's list of supported fonts

This property can be used as the source for data binding.


Implementation
    public function get applicationFontList():Array
    public function set applicationFontList(value:Array):void
authoringModeproperty 
authoringMode:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A Boolean indicating whether or not the host is in authoring mode.

This property can be used as the source for data binding.


Implementation
    public function get authoringMode():Boolean
    public function set authoringMode(value:Boolean):void
collectionDropManagerproperty 
collectionDropManager:ICollectionDropManager  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the ICollectionDropManager exposed by the host.


Implementation
    public function get collectionDropManager():ICollectionDropManager
colorPaletteproperty 
colorPalette:ColorPalette

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current color palette as specified by the viewing application.

This property can be used as the source for data binding.


Implementation
    public function get colorPalette():ColorPalette
    public function set colorPalette(value:ColorPalette):void
currentFolderproperty 
currentFolder:IAttachment

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the current folder whose contents are being viewed, or null if the root is currently being viewed. The items of the folder that is returned correspond to the currentItems property of this folder. When a new current folder is set, the SelectedItems array is set to [], since the current folder has been changed, so there are no selected items yet.

This property can be used as the source for data binding.


Implementation
    public function get currentFolder():IAttachment
    public function set currentFolder(value:IAttachment):void
currentItemsproperty 
currentItems:AttachmentCollection

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the items currently being viewed. The items in this collection are contained in the object specified by currentFolder. This property will be null until the instance has been enabled.

This property can be used as the source for data binding.


Implementation
    public function get currentItems():AttachmentCollection
    public function set currentItems(value:AttachmentCollection):void

See also

defaultFocusItemproperty 
public var defaultFocusItem:IFocusManagerComponent

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A UI component that's suitable for receiving focus by default.

embeddedFontListproperty 
embeddedFontList:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function returns the array of fonts that are embedded in the portfolio.

This property can be used as the source for data binding.


Implementation
    public function get embeddedFontList():Array
    public function set embeddedFontList(value:Array):void
enabledproperty 
enabled:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

true if the collectionManager instance is enabled, false otherwise. rootItems and currentItems will be null until the instance is enabled.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
fieldsproperty 
fields:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The array of fields displayed in the Files view of the Portfolio

This property can be used as the source for data binding.


Implementation
    public function get fields():Array
    public function set fields(value:Array):void
fileNameproperty 
fileName:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns the file name of the collection, or the empty string if the host or the collection is null.


Implementation
    public function get fileName():String
fixedNavigatorColorPaletteproperty 
fixedNavigatorColorPalette:Object

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the fixed navigator color palette, if there is one. Some navigators (such as Details) want to always have the same look independent of the host color palette changed, unless a high contrast color palette is used.


Implementation
    public function get fixedNavigatorColorPalette():Object
    public function set fixedNavigatorColorPalette(value:Object):void
focusAttachmentproperty 
focusAttachment:IAttachment

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the current IAttachment considered to have focus. This may be null.

This property can be used as the source for data binding.


Implementation
    public function get focusAttachment():IAttachment
    public function set focusAttachment(value:IAttachment):void
focusIndexproperty 
focusIndex:int

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the index of the current focus attachment. focusIndex is used to keep track of what IAttachment is currently in focus and what its next and previous attachments are. focusIndex can be set explicitly by set focusIndex(), or indirectly by handleNewFocus().

This property can be used as the source for data binding.


Implementation
    public function get focusIndex():int
    public function set focusIndex(value:int):void
hostproperty 
host:INavigatorHost

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the current INavigatorHost used to communicate with the viewing application. When the navigator host changes, the old host's event listeners are removed and the following new event listerners are added to the new navigator host: "currentFolderChanged", "navigatorColorPaletteChanged", RightClickEvent.RIGHT_CLICK, "needsSave", "permissionsChanged", PropertyChangeEvent.PROPERTY_CHANGE, PropertyChangeEvent.PROPERTY_CHANGE, "applicationFontListChanged". Also, events of type CollectionManagerEvent.HOST_CHANGED_KIND and CollectionManagerEvent.PERMISSIONS_CHANGED_KIND are dispatched so that clients can properly handle these events.

This property can be used as the source for data binding.


Implementation
    public function get host():INavigatorHost
    public function set host(value:INavigatorHost):void

See also

instanceproperty 
instance:CollectionManager  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A static instance that can be shared by Flex components.


Implementation
    public static function get instance():CollectionManager
isNavPreviewCardPreviewproperty 
isNavPreviewCardPreview:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates whether a card is being previewing in the NavPreview component

This property can be used as the source for data binding.


Implementation
    public function get isNavPreviewCardPreview():Boolean
    public function set isNavPreviewCardPreview(value:Boolean):void
localeLanguagePrefixproperty 
localeLanguagePrefix:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns the prefix for the locale language, for example "en" or "fr"


Implementation
    public function get localeLanguagePrefix():String
newOrderedListproperty 
public var newOrderedList:IList

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A cache of the newly ordered list. This needs to be sent over the bridge for reordering. Since we can reorder between folders and hence can be in different lists alltogether, this has to be cached centrally.

nextAttachmentproperty 
nextAttachment:IAttachment

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the attachment following focusAttachment in the current sort order. This may be null.

This property can be used as the source for data binding.


Implementation
    public function get nextAttachment():IAttachment
    public function set nextAttachment(value:IAttachment):void
prevAttachmentproperty 
prevAttachment:IAttachment

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the attachment following focusAttachment in the current sort order. This may be null.

This property can be used as the source for data binding.


Implementation
    public function get prevAttachment():IAttachment
    public function set prevAttachment(value:IAttachment):void
queueRootItemsproperty 
public var queueRootItems:Boolean = true

If true, then attachments will be added to the rootItems collection incrementally, rather than all at once. This can improve startup performance for navigators whose startup performance is dependent on the number of root items.

rootItemsproperty 
rootItems:AttachmentCollection

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The root items in a collection. This property will be null until the instance has been enabled.

This property can be used as the source for data binding.


Implementation
    public function get rootItems():AttachmentCollection
    public function set rootItems(value:AttachmentCollection):void

See also

rootItemsJobQueueproperty 
rootItemsJobQueue:JobQueue  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The job queue that trickles attachments into the root collection in the initialization phase of the Navigator.


Implementation
    public function get rootItemsJobQueue():JobQueue
selectedItemsproperty 
selectedItems:ArrayCollection  [read-only]

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Indicates the currently selected items in the collection.


Implementation
    public function get selectedItems():ArrayCollection

See also

sortproperty 
sort:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An ISort array the indicates the sort order to use.

This property can be used as the source for data binding.


Implementation
    public function get sort():Array
    public function set sort(value:Array):void

See also

ISort
Constructor Detail
CollectionManager()Constructor
public function CollectionManager(token:Object)

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor

Parameters
token:Object
Method Detail
apiIsSupported()method
public function apiIsSupported(requestedVersion:Array):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function returns true if the host supports this version of the Portfolio API; otherwise it returns false.

Parameters

requestedVersion:Array

Returns
Boolean

See also

deleteAttachments()method 
public function deleteAttachments(attachmentArray:Array, response:Function = null):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Deletes the set of attachments in attachmentArray from the Portfolio

Parameters

attachmentArray:Array
 
response:Function (default = null)

dispatchNavigatorPreview()method 
public function dispatchNavigatorPreview(attachment:IAttachment):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Dispatches a CollectionManagerEvent indicating that a navigator preview should be displayed.

Parameters

attachment:IAttachment

See also

CollectionManagerEvent.NAVIGATOR_PREVIEW_KIND
dispatchPartRemoved()method 
public function dispatchPartRemoved(oldPart:Object):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Dispatches a CollectionManagerEvent indicating that a skin part has been removed. This allows skin parts to listen for events from the collection manager so that cleanup (removing event listeners) can be performed.

Parameters

oldPart:Object

See also

CollectionManagerEvent.PART_REMOVED_KIND
focusAndSelectionEventsSuspended()method 
public function focusAndSelectionEventsSuspended():Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns true if Focus and Selection Events are currently suspended; false otherwise.

Returns
Boolean
getCurrentIndex()method 
public function getCurrentIndex(attachment:IAttachment):int

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns the index of attachment in currentItems, or -1 if currentItems does not contain attachment.

Parameters

attachment:IAttachment

Returns
int
getDefaultFontName()method 
public function getDefaultFontName(includeDefaultFont:Boolean):String

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function returns the name of the application's default font. This includes some language-dependent overrides on the application font. The usual default is "Myriad Pro". If there is no default font, the string "applicationFont" is returned.

Parameters

includeDefaultFont:Boolean

Returns
String
getDirty()method 
public function getDirty(response:Function):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Asynchronously returns the state of the host collection dirty flag.

Parameters

response:Function

See also

ICollection.getDirty
handleCurrentFolder()method 
protected function handleCurrentFolder(newFolder:IAttachment):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function adjusts the state of the CollectionManager, given a new current folder.

Parameters

newFolder:IAttachment

handleNewFocus()method 
protected function handleNewFocus(oldVal:IAttachment):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function adjusts the state of the CollectionManager, given a new focused attachment.

Parameters

oldVal:IAttachment

handlePreview()method 
public function handlePreview(attachment:IAttachment):void

Invokes the appropriate preview behavior for both file and folder attachments.

Parameters

attachment:IAttachment

isMyriadSupported()method 
public function isMyriadSupported():Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function returns true if "Myriad Pro" font is supported, false otherwise. "Myriad Pro" is the usual default font.

Returns
Boolean
itemsAreCurrent()method 
public function itemsAreCurrent(dataProvider:IList):Boolean

Returns true if the dataProvider for a list matches the CollectionMgr's currentItems. Things like focus and selection should only be propagated to the CollectionMgr if the dataProvider is current.

Parameters

dataProvider:IList

Returns
Boolean
onCollectionPropagateEvent()method 
protected function onCollectionPropagateEvent(event:Event):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A listener that receives events from host.collection and propagates them using NavHostEvents.

Parameters

event:Event

onCollectionPropertyChanged()method 
protected function onCollectionPropertyChanged(evt:PropertyChangeEvent):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A listener to handle changes to properties on host.collection.

Parameters

evt:PropertyChangeEvent

onCurrentFolderChanged()method 
protected function onCurrentFolderChanged(evt:Event):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Listener to handle folder changes from the host.

Parameters

evt:Event

onCurrentItemsChange()method 
protected function onCurrentItemsChange(evt:CollectionEvent):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

A listener that adjusts the current focus when currentItems changes.

Parameters

evt:CollectionEvent

onGotoNextAttachment()method 
public function onGotoNextAttachment(evt:Event):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An event listener that gives focus to the next attachment, if it exists.

Parameters

evt:Event

onGotoPreviousAttachment()method 
public function onGotoPreviousAttachment(evt:Event):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An event listener that gives focus to the previous attachment, if it exists.

Parameters

evt:Event

onHostPropertyChanged()method 
protected function onHostPropertyChanged(event:Event):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Listener to handle simple property changes from the host.

Parameters

event:Event

onRightClick()method 
protected function onRightClick(event:RightClickEvent):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Listener to propagate right-click events from the host.

Parameters

event:RightClickEvent

onSelectionChanged()method 
protected function onSelectionChanged(value:Array):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Listener to handle selection changes from the host.

Parameters

value:Array

permissionCheck()method 
public function permissionCheck(category:String, permission:String):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Returns true if the given category/permission combination is allowed in the host, or false otherwise.

Parameters

category:String
 
permission:String

Returns
Boolean

See also

IPermissions.check
queryAdobeHost()method 
public function queryAdobeHost(app:Application):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Determines if the provided Application is an Adobe-supported host.

Parameters

app:Application

Returns
Boolean
requeueList()method 
protected function requeueList(jobUtil:JobQueue, items:IList, timerInterval:Number = 20):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Trickles attachments into the root collection in the initialization phase of the Navigator.

This gives Navigators the chance to update the UI and provide for scrolling, etc. while the attachments are being added.

Parameters

jobUtil:JobQueue
 
items:IList
 
timerInterval:Number (default = 20)

setCurrentItems()method 
protected function setCurrentItems(value:IList):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Takes the IList of items passed to it and make these the list of currentItems. It broadcasts appropriate events so that clients can respond to the change in current items.

Parameters

value:IList

setDirty()method 
public function setDirty():void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Marks the host collection as "dirty", which enables Save in the application UI.

setHostFromApplication()method 
public function setHostFromApplication(val:INavigatorHost, app:Application):Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sets the host to be used by this class in the context of the given application. Applications that are not Adobe-supported may have limited functionality.

Parameters

val:INavigatorHost
 
app:Application

Returns
Boolean

See also

setSelectedItems()method 
public function setSelectedItems(val:Array):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sets the selected items to an array of IAttachment objects.

Parameters

val:Array

See also

suspendFocusAndSelectionEvents()method 
public function suspendFocusAndSelectionEvents():void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Calling this function tells the navigator to ignore focus changes. This is useful when a series of events need to occur before the actual focus change.

unsuspendFocusAndSelectionEvents()method 
public function unsuspendFocusAndSelectionEvents():void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

This function turns off the previously called suspension of Focus and Selection Events. There may be multiple calls to suspendFocusAndSelectionEvents(), so the navigator maintains a count of the number of such calls. For each call to suspendFocusAndSelectionEvents() you must have a matching call to unsuspendFocusAndSelectionEvents() before the focus change will be handled.

updateColorPalette()method 
public function updateColorPalette(paletteObject:Object):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Updates the color palette used by the viewing application to be the palette passed to updateColorPalette().

Parameters

paletteObject:Object

Event Detail
navHost Event
Event Object Type: com.adobe.portfolio.events.CollectionManagerEvent
CollectionManagerEvent.type property = com.adobe.portfolio.events.NavHostEvent.NAV_HOST

Dispatched after various updates to the navigator host.

See also

CollectionManagerEvent
rightClick Event  
Event Object Type: com.adobe.portfolio.api.RightClickEvent
RightClickEvent.type property = com.adobe.portfolio.api.RightClickEvent.RIGHT_CLICK

Dispatched when a right click event is received from the host.

Defines the value of the type property of the Event object for a rightClick event.
Constant Detail
API_VERSION_10Constant
public static const API_VERSION_10:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An array representing the Portfolio API v10.0.

See also

API_VERSION_9_5Constant 
public static const API_VERSION_9_5:Array

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

An array representing the Portfolio API v9.5.

See also