Packagecom.adobe.portfolio.managers
Classpublic class PropertyManager
InheritancePropertyManager Inheritance flash.events.EventDispatcher

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

PropertyManager loads nav property XML files and propagates their contents to the navigator host. PropertyManager does not contain logic for handling property behavior, but does contain a reference to a CommonProperties object for dealing with such behavior.


Public Properties
 PropertyDefined By
  commonProperties : CommonProperties
A CommonProperties instance that can be accessed by navigator components for setting and responding to property changes, and is suitable for binding.
PropertyManager
  currentContext : PropertyContext
The current property context of the host
PropertyManager
  globalContexts : ArrayCollection
XXXXX
PropertyManager
  instance : PropertyManager
[static] [read-only] A PropertyManager static instance that can be shared by Flex components.
PropertyManager
  knownContexts : ArrayCollection
Returns an ArrayCollection that contains the currently loaded property contexts.
PropertyManager
Protected Properties
 PropertyDefined By
  _instance : PropertyManager = null
[static] Internal representation of the PropertyManager referenced by the instance getter.
PropertyManager
Public Methods
 MethodDefined By
  
PropertyManager(target:IEventDispatcher = null)
Constructor
PropertyManager
  
getNavProperty(contextName:String, propertyName:String):PropertyValue
Returns the navigator property with the specified name (propertyName) from the given context (contextName), or null if no such property has been loaded.
PropertyManager
  
loadPropertyXML(propertyURL:String):void
Load the properties specified in the XML file specified by propertyURL and propagates the contents to the Navigator host.
PropertyManager
  
updateHostContexts():void
Checks to see if we are in authoring mode and environment that supports this API.
PropertyManager
Protected Methods
 MethodDefined By
  
addContext(newContext:PropertyContext):void
Adds the specified propertyContext to the knownContents ArrayCollection.
PropertyManager
Events
 Event Summary Defined By
  
complete
PropertyManager
  
navPropertyContextLoaded
PropertyManager
  
navPropertyUpdatedContexts
PropertyManager
Property Detail
_instanceproperty
protected static var _instance:PropertyManager = null

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

Internal representation of the PropertyManager referenced by the instance getter.

commonPropertiesproperty 
commonProperties:CommonProperties

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

A CommonProperties instance that can be accessed by navigator components for setting and responding to property changes, and is suitable for binding.

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


Implementation
    public function get commonProperties():CommonProperties
    public function set commonProperties(value:CommonProperties):void
currentContextproperty 
currentContext:PropertyContext

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

The current property context of the host


Implementation
    public function get currentContext():PropertyContext
    public function set currentContext(value:PropertyContext):void
globalContextsproperty 
globalContexts:ArrayCollection

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

XXXXX

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


Implementation
    public function get globalContexts():ArrayCollection
    public function set globalContexts(value:ArrayCollection):void
instanceproperty 
instance:PropertyManager  [read-only]

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

A PropertyManager static instance that can be shared by Flex components.


Implementation
    public static function get instance():PropertyManager
knownContextsproperty 
knownContexts:ArrayCollection

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

Returns an ArrayCollection that contains the currently loaded property contexts. A propety context provides labels and descriptions for UI properties

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


Implementation
    public function get knownContexts():ArrayCollection
    public function set knownContexts(value:ArrayCollection):void
Constructor Detail
PropertyManager()Constructor
public function PropertyManager(target:IEventDispatcher = null)

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

Constructor

Parameters
target:IEventDispatcher (default = null)
Method Detail
addContext()method
protected function addContext(newContext:PropertyContext):void

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

Adds the specified propertyContext to the knownContents ArrayCollection.

Parameters

newContext:PropertyContext

getNavProperty()method 
public function getNavProperty(contextName:String, propertyName:String):PropertyValue

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

Returns the navigator property with the specified name (propertyName) from the given context (contextName), or null if no such property has been loaded.

Parameters

contextName:String
 
propertyName:String

Returns
PropertyValue
loadPropertyXML()method 
public function loadPropertyXML(propertyURL:String):void

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

Load the properties specified in the XML file specified by propertyURL and propagates the contents to the Navigator host.

Parameters

propertyURL:String

updateHostContexts()method 
public function updateHostContexts():void

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

Checks to see if we are in authoring mode and environment that supports this API. If so, the host's propertyContexts is set to the globalContexts. Otherwise pendingPropertiesUpdate is set to true.

Event Detail
complete Event

navPropertyContextLoaded Event  
Event Object Type: com.adobe.portfolio.events.NavPropertyEvent

navPropertyUpdatedContexts Event  
Event Object Type: com.adobe.portfolio.events.NavPropertyEvent




Copyright Adobe Systems Incorporated, all rights reserved, for internal use only

Mon Oct 11 2010, 01:58 PM -07:00