Packagecom.adobe.portfolio.properties
Classpublic class PropertyListValue
InheritancePropertyListValue Inheritance PropertyValue Inheritance flash.events.EventDispatcher
Subclasses FontList, ThemeFilteredList

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

This interface extends PropertyValue to provide support for lists of PropertyValues displayed in the user interface.



Public Properties
 PropertyDefined By
  activeValue : PropertyValue
The currently active value.
PropertyListValue
 Inheriteddescription : String
A localized description string suitable for display in the user interface.
PropertyValue
 Inheriteddirty : Boolean
Returns true if the property has been modified and needs to be saved, false otherwise.
PropertyValue
 Inheritedenabled : Boolean
Returns a value of true if the control(s) representing this property should be enabled in the user interface.
PropertyValue
 InheritedhasMinMax : Boolean
[read-only] Returns a value of true if this property has relevant minimum or maximum values.
PropertyValue
 Inheritedlabel : String
A localized label string suitable for display in the user interface.
PropertyValue
 InheritedmaxValue : Number
[read-only] The maximum value of this numeric property.
PropertyValue
 InheritedminValue : Number
[read-only] The minimum value of this numeric property.
PropertyValue
 Inheritedname : String
The name for this IProperty.
PropertyValue
  subvalues : Array
[override] [read-only] The array of possible values for a PropertyList
PropertyListValue
  subvaluesLocked : Boolean
[override] [read-only] Returns true if elements of subvalues for this property cannot be added or removed.
PropertyListValue
  subvaluesType : String
[override] [read-only] Identifies the data type of the IProperty elements found in the subvalues array.
PropertyListValue
  type : String
[override] [read-only] Identifies the data type of this IProperty.
PropertyListValue
 Inheritedvalue : Object
The value for this IProperty.
PropertyValue
 Inheritedvisible : Boolean
Returns a value of true if the control(s) representing this property should be displayed in the user interface.
PropertyValue
Protected Properties
 PropertyDefined By
 InheriteddescriptionDefault : String
The default description string to be used when the localized description is unavailable.
PropertyValue
 InheriteddescriptionKey : String
The string used as a key to request a localized description string.
PropertyValue
 InheriteddontPlayEffectsCounter : uint = 0
A counter used to keep track of when to run the side effects.
PropertyValue
 Inheritedinitializing : Boolean
Returns true if the property is in an initializing state, false otherwise.
PropertyValue
 InheritedlabelDefault : String
The default label string to be used when the localized label is unavailable.
PropertyValue
 InheritedlabelKey : String
The string used as a key to request a localized label string.
PropertyValue
  loadAndSaveValues : Boolean
[read-only] Returns false if loading and saving values to and from XML should be skipped.
PropertyListValue
 Inheritedparent : Object
The parent object of this property.
PropertyValue
  shouldOutputSubvalues : Boolean
[read-only] Returns true.
PropertyListValue
  _subvalues : Array
The array of possible values for a PropertyList
PropertyListValue
Public Methods
 MethodDefined By
  
PropertyListValue(target:IEventDispatcher = null)
Constructor
PropertyListValue
 Inherited
createPropertyValue(valueXML:XML, parent:Object):PropertyValue
[static] Create a new PropertyValue instance of the correct type and assign parent as its parent value.
PropertyValue
 Inherited
Create an XML object with all its XML elements for this property.
PropertyValue
  
loadFromXML(valueXML:XML):Boolean
[override] Loads the list of property values from the specified XML value.
PropertyListValue
 Inherited
Run all the effects in the selectEffectArray If dontPlayEffectsCounter is false (not 0) playSelectEffects() will not run the effects.
PropertyValue
  
referenceSubvalueResources(referenceType:int):void
References, dereferences, or touches all URL subvalues.
PropertyListValue
  
setValueFromString(valueString:String):Boolean
[override] Sets the value of this property to a string-based representation of the desired property value.
PropertyListValue
  
updateSubvalues(newSubvalues:Array, newActiveValue:PropertyValue = null):void
Update the subvalues and active value of the property list to the new list and preperty value
PropertyListValue
Protected Methods
 MethodDefined By
  
[override] Returns the XML element name for this property.
PropertyListValue
  
setXMLElements(propertyXML:XML):void
[override] Sets all the XML elements for this property, such as enabled, visible, label, and description.
PropertyListValue
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = PropertyList
[static] The XML element name for PropertyLists
PropertyListValue
Property Detail
_subvaluesproperty
protected var _subvalues:Array

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

The array of possible values for a PropertyList

activeValueproperty 
activeValue:PropertyValue

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

The currently active value.

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


Implementation
    public function get activeValue():PropertyValue
    public function set activeValue(value:PropertyValue):void
loadAndSaveValuesproperty 
loadAndSaveValues:Boolean  [read-only]

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

Returns false if loading and saving values to and from XML should be skipped. This may be desirable if the list values are based on the runtime state of the system.


Implementation
    protected function get loadAndSaveValues():Boolean
shouldOutputSubvaluesproperty 
shouldOutputSubvalues:Boolean  [read-only]

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

Returns true. The default (unless overridden) is to output subvalues to XML.


Implementation
    protected function get shouldOutputSubvalues():Boolean
subvaluesproperty 
subvalues:Array  [read-only] [override]

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

The array of possible values for a PropertyList


Implementation
    public function get subvalues():Array
subvaluesLockedproperty 
subvaluesLocked:Boolean  [read-only] [override]

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

Returns true if elements of subvalues for this property cannot be added or removed.


Implementation
    public function get subvaluesLocked():Boolean
subvaluesTypeproperty 
subvaluesType:String  [read-only] [override]

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

Identifies the data type of the IProperty elements found in the subvalues array.


Implementation
    public function get subvaluesType():String
typeproperty 
type:String  [read-only] [override]

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

Identifies the data type of this IProperty.

It must be one of the property types defined in PropertyType.


Implementation
    public function get type():String

See also

PropertyType.LIST
Constructor Detail
PropertyListValue()Constructor
public function PropertyListValue(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
getXMLElementName()method
override protected function getXMLElementName():String

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

Returns the XML element name for this property.

Returns
String
loadFromXML()method 
override public function loadFromXML(valueXML:XML):Boolean

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

Loads the list of property values from the specified XML value.

Parameters

valueXML:XML — The XML object to load that contains the list of property values as its elements.

Returns
Boolean
referenceSubvalueResources()method 
public function referenceSubvalueResources(referenceType:int):void

References, dereferences, or touches all URL subvalues.

Parameters

referenceType:int — If greater than zero, referenceResource is called on all URL subvalues; if less than zero, dereferenceResource is called; if equal to zero, touchResource is called.

See also

setValueFromString()method 
override public function setValueFromString(valueString:String):Boolean

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

Sets the value of this property to a string-based representation of the desired property value.

Parameters

valueString:String

Returns
Boolean
setXMLElements()method 
override protected function setXMLElements(propertyXML:XML):void

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

Sets all the XML elements for this property, such as enabled, visible, label, and description. Also, set any SelectEffect XML objects in the SelectEffectsArray.

Parameters

propertyXML:XML — XML object representing the desired property

updateSubvalues()method 
public function updateSubvalues(newSubvalues:Array, newActiveValue:PropertyValue = null):void

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

Update the subvalues and active value of the property list to the new list and preperty value

Parameters

newSubvalues:Array — The new list of property values to use
 
newActiveValue:PropertyValue (default = null) — The value to use as the new active value

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = PropertyList

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

The XML element name for PropertyLists