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.
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
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.
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.
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
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:
Changes in properties
Changes in color values for the color palette
As long as dontPlayEffectsCounter is not 0
playSelectEffects() will not run the effects.
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
hasMinMax: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 this property has relevant minimum or maximum values.
It returns false
otherwise.
This applies to numeric properties.
Implementation public function get hasMinMax():Boolean
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
label:String
Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0
A localized label string 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
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.
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.
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 numeric property.
This applies to numeric properties.
Implementation public function get maxValue():Number
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 numeric property.
This applies to numeric properties.
Implementation public function get minValue():Number
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 name serves as a unique identifier, and never changes.
This property can be used as the source for data binding.
Implementation public function get name():String
public function set name(value:String):void
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.
subvalues:Array
[read-only]
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 list property.
This applies to list properties.
Implementation public function get subvalues():Array
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. It returns false
otherwise.
This applies to list properties.
Implementation public function get subvaluesLocked():Boolean
subvaluesType: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 the IProperty
elements found in the
subvalues
array.
It must be one of the property types defined in PropertyType
.
Implementation public function get subvaluesType():String
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
.
It must be one of the property types defined in PropertyType
.
Implementation public function get type():String
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
.
Its type is determined by type
.
This property can be used as the source for data binding.
Implementation public function get value():Object
public function set value(value:Object):void
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
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
)
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 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 for this property.
Returns 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 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
Returns Boolean
— true
if the property was successfully loaded,
false
otherwise.
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:
Changes in properties
Changes in color values for the color palette
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
Returns 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
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
The XML element name for generic property values
Copyright Adobe Systems Incorporated, all rights reserved, for internal use only Mon Apr 25 2011, 05:54 PM -07:00