| Package | com.adobe.portfolio.properties |
| Class | public class PropertyListValue |
| Inheritance | PropertyListValue  PropertyValue 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 |
| Property | Defined By | ||
|---|---|---|---|
| activeValue : PropertyValue
The currently active value. | PropertyListValue | ||
 | description : String
A localized description string suitable for display in the user interface. | PropertyValue | |
| dirty : Boolean
Returns true if the property has been modified and needs to be saved,
false otherwise. | PropertyValue | |
| enabled : Boolean
Returns a value of true if the control(s) representing this property
should be enabled in the user interface. | PropertyValue | |
| hasMinMax : Boolean [read-only]
Returns true if this property has meaningful minimum or maximum values. | PropertyValue | |
| label : String
The localized label string for this IProperty, suitable for display in the user interface. | PropertyValue | |
| maxValue : Number [read-only]
The maximum value of this property, as specified by the navigator. | PropertyValue | |
| minValue : Number [read-only]
The minimum value of this property, as specified by the navigator. | PropertyValue | |
| name : 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]
The type (LIST) of the PropertyListValue
| PropertyListValue | ||
| value : Object
The value for this IProperty. | PropertyValue | |
| visible : Boolean
Returns a value of true if the control(s) representing this property
should be displayed in the user interface. | PropertyValue | |
| Property | Defined By | ||
|---|---|---|---|
| descriptionDefault : String
The default description string to be used when the localized description is unavailable. | PropertyValue | |
| descriptionKey : String
The string used as a key to request a localized description string. | PropertyValue | |
| dontPlayEffectsCounter : uint = 0
A counter used to keep track of when to run the side effects. | PropertyValue | |
| initializing : Boolean
Returns true if the property is in an initializing state,
false otherwise. | PropertyValue | |
| labelDefault : String
The default label string to be used when the localized label is unavailable. | PropertyValue | |
| labelKey : 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 | ||
| parent : Object
The parent object of this property. | PropertyValue | |
| shouldOutputSubvalues : Boolean [read-only]
XXXXX
| PropertyListValue | ||
| _subvalues : Array
The array of possible values for a PropertyList
| PropertyListValue | ||
| Method | Defined By | ||
|---|---|---|---|
PropertyListValue(target:IEventDispatcher = null)
Constructor
| PropertyListValue | ||
| createPropertyValue(valueXML:XML, parent:Object):PropertyValue [static]
Create a new PropertyValue instance of the correct type and
assign parent as its parent value. | PropertyValue | |
| generateXML():XML
Create an XML object with all its XML elements. | PropertyValue | |
loadFromXML(valueXML:XML):Boolean [override]
Loads the list of property values from the specified XML value. | PropertyListValue | ||
| playSelectEffects():void
Run all the effects in the selectEffectArray
If dontPlayEffectsCounter is false (not 0)
playSelectEffects() will not run the effects. | PropertyValue | |
setValueFromString(valueString:String):Boolean [override]
XXXXX
| 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 | ||
| Method | Defined By | ||
|---|---|---|---|
getXMLElementName():String [override]
XXXXX
| PropertyListValue | ||
setXMLElements(propertyXML:XML):void [override]
XXXXX
| PropertyListValue | ||
| Constant | Defined By | ||
|---|---|---|---|
| XML_ELEMENT_NAME : String = PropertyList [static]
The XML element name for PropertyLists
| PropertyListValue | ||
| _subvalues | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected 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
| activeValue | property |
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.
public function get activeValue():PropertyValue public function set activeValue(value:PropertyValue):void| loadAndSaveValues | property |
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.
protected function get loadAndSaveValues():Boolean| shouldOutputSubvalues | property |
shouldOutputSubvalues:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
XXXXX
protected function get shouldOutputSubvalues():Boolean| subvalues | property |
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
public function get subvalues():Array| subvaluesLocked | property |
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.
public function get subvaluesLocked():Boolean| subvaluesType | property |
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.
public function get subvaluesType():String| type | property |
type:String [read-only] [override] | Language Version : | ActionScript 3.0 |
| Product Version : | Portfolio 10.0 |
| Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The type (LIST) of the PropertyListValue
public function get type():String| 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
Parameterstarget:IEventDispatcher (default = null) |
| 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 |
XXXXX
ReturnsString |
| 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.
|
Boolean |
| 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 |
XXXXX
Parameters
valueString:String |
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 |
XXXXX
Parameters
propertyXML:XML |
| 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) |
| XML_ELEMENT_NAME | Constant |
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