Packagecom.adobe.portfolio.properties
Classpublic class PropertyValue
InheritancePropertyValue Inheritance flash.events.EventDispatcher
Implements IProperty
Subclasses CanvasTemplate, PropertyActionValue, PropertyBinaryValue, PropertyBooleanValue, PropertyListValue, PropertyNumberValue, PropertyStringValue

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

This interface implements IProperty and provides support for properties displayed in the user interface.


Public Properties
 PropertyDefined By
  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
[read-only] An array of all properties (of type IPropertyValue) within this list.
PropertyValue
  subvaluesLocked : Boolean
[read-only] Returns a value of true if elements of subvalues for this property cannot be added or removed.
PropertyValue
  subvaluesType : String
[read-only] Returns the type of the properties within this list; one of the string constants defined by PropertyType
PropertyValue
  type : String
[read-only] Identifies the data type of this IProperty.
PropertyValue
  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
Protected Properties
 PropertyDefined 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
  parent : Object
The parent object of this property.
PropertyValue
Public Methods
 MethodDefined By
  
PropertyValue(target:IEventDispatcher = null)
Constructor
PropertyValue
  
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
Load the specified value from an XML object.
PropertyValue
  
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
XXXXX
PropertyValue
Protected Methods
 MethodDefined By
  
getXMLElementName():String
Returns the XML element name.
PropertyValue
  
setXMLElements(propertyXML:XML):void
Sets all the XML elements for the XML property, such as enabled, visible, label, and description.
PropertyValue
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = PropertyValue
[static] XXXXX
PropertyValue
Property Detail
descriptionproperty
description:String

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

A localized description string suitable for display in the user interface.

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


Implementation
    public function get description():String
    public function set description(value:String):void
descriptionDefaultproperty 
protected var descriptionDefault:String

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

The default description string to be used when the localized description is unavailable.

descriptionKeyproperty 
protected var descriptionKey:String

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

The string used as a key to request a localized description string.

dirtyproperty 
dirty:Boolean

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

Returns true if the property has been modified and needs to be saved, false otherwise.


Implementation
    public function get dirty():Boolean
    public function set dirty(value:Boolean):void
dontPlayEffectsCounterproperty 
protected var dontPlayEffectsCounter:uint = 0

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

A counter used to keep track of when to run the side effects. There are two types of effects:

  1. Changes in properties
  2. Changes in color values for the color palette

As long as dontPlayEffectsCounter is not 0 playSelectEffects() will not run the effects.

enabledproperty 
enabled:Boolean

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

Returns a value of true if the control(s) representing this property should be enabled in the user interface. It returns false otherwise.

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


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
hasMinMaxproperty 
hasMinMax:Boolean  [read-only]

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

Returns true if this property has meaningful minimum or maximum values.


Implementation
    public function get hasMinMax():Boolean
initializingproperty 
initializing:Boolean

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

Returns true if the property is in an initializing state, false otherwise.


Implementation
    protected function get initializing():Boolean
    protected function set initializing(value:Boolean):void
labelproperty 
label:String

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

The localized label string for this IProperty, suitable for display in the user interface.

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


Implementation
    public function get label():String
    public function set label(value:String):void
labelDefaultproperty 
protected var labelDefault:String

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

The default label string to be used when the localized label is unavailable.

labelKeyproperty 
protected var labelKey:String

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

The string used as a key to request a localized label string.

maxValueproperty 
maxValue:Number  [read-only]

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

The maximum value of this property, as specified by the navigator.


Implementation
    public function get maxValue():Number
minValueproperty 
minValue:Number  [read-only]

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

The minimum value of this property, as specified by the navigator.


Implementation
    public function get minValue():Number
nameproperty 
name:String

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

The name for this IProperty.

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


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
protected var parent:Object

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

The parent object of this property.

subvaluesproperty 
subvalues:Array  [read-only]

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

An array of all properties (of type IPropertyValue) within this list.


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

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

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


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

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

Returns the type of the properties within this list; one of the string constants defined by PropertyType


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

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.


Implementation
    public function get type():String
valueproperty 
value:Object

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

The value for this IProperty.

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


Implementation
    public function get value():Object
    public function set value(value:Object):void
visibleproperty 
visible:Boolean

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

Returns a value of true if the control(s) representing this property should be displayed in the user interface. It returns false otherwise.

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


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor Detail
PropertyValue()Constructor
public function PropertyValue(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
createPropertyValue()method
public static function createPropertyValue(valueXML:XML, parent:Object):PropertyValue

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

Create a new PropertyValue instance of the correct type and assign parent as its parent value.

Parameters

valueXML:XML — the value to set
 
parent:Object — the parent object for the property

Returns
PropertyValue — the property value created
generateXML()method 
public function generateXML():XML

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

Create an XML object with all its XML elements.

Returns
XML
getXMLElementName()method 
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.

Returns
String
loadFromXML()method 
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

Load the specified value from an XML object. If possible, the localized label and description will be used.

Parameters

valueXML:XML

Returns
Boolean — true if the property was successfully loaded, false otherwise.
playSelectEffects()method 
public function playSelectEffects():void

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

Run all the effects in the selectEffectArray If dontPlayEffectsCounter is false (not 0) playSelectEffects() will not run the effects. There are two types of effects:

  1. Changes in properties
  2. Changes in color values for the color palette

setValueFromString()method 
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

Returns
Boolean
setXMLElements()method 
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 the XML 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

Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = PropertyValue

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

XXXXX




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

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