Packagecom.adobe.portfolio.properties
Classpublic class PropertyActionValue
InheritancePropertyActionValue Inheritance PropertyValue Inheritance flash.events.EventDispatcher

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

This class handles property values that are actions.



Public Properties
 PropertyDefined By
 Inheriteddescription : String
A localized description string suitable for display in the user interface.
PropertyValue
  dirty : Boolean
[override] Overrides the normal function to set the dirty flag.
PropertyActionValue
 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
 Inheritedsubvalues : Array
[read-only] The array of possible values for a list property.
PropertyValue
 InheritedsubvaluesLocked : Boolean
[read-only] Returns a value of true if elements of subvalues for this property cannot be added or removed.
PropertyValue
 InheritedsubvaluesType : String
[read-only] Identifies the data type of the IProperty elements found in the subvalues array.
PropertyValue
  type : String
[override] [read-only] Identifies the data type of this IProperty.
PropertyActionValue
  value : Object
[override] Set the property's action value.
PropertyActionValue
 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
 Inheritedparent : Object
The parent object of this property.
PropertyValue
Public Methods
 MethodDefined By
  
PropertyActionValue(target:IEventDispatcher = null)
Constructor
PropertyActionValue
 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] Load the specified value from an XML object.
PropertyActionValue
 Inherited
Run all the effects in the selectEffectArray If dontPlayEffectsCounter is false (not 0) playSelectEffects() will not run the effects.
PropertyValue
 Inherited
setValueFromString(valueString:String):Boolean
Sets the value of this property to a string-based representation of the desired property value.
PropertyValue
Protected Methods
 MethodDefined By
  
[override] Returns the XML element name for this property.
PropertyActionValue
 Inherited
setXMLElements(propertyXML:XML):void
Sets all the XML elements for this property, such as enabled, visible, label, and description.
PropertyValue
Public Constants
 ConstantDefined By
  XML_ELEMENT_NAME : String = PropertyAction
[static] The XML element name for property actions
PropertyActionValue
Property Detail
dirtyproperty
dirty:Boolean[override]

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

Overrides the normal function to set the dirty flag. Action values aren't stored, so there is nothing to mark as dirty.


Implementation
    public function get dirty():Boolean
    public function set dirty(value:Boolean):void
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.ACTION
valueproperty 
value:Object[override]

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

Set the property's action value. Changing the value to a non-zero uint will generally trigger the action, as well as any select effects on the property.


Implementation
    public function get value():Object
    public function set value(value:Object):void

See also

Constructor Detail
PropertyActionValue()Constructor
public function PropertyActionValue(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

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

Parameters

valueXML:XML

Returns
Booleantrue if the property was successfully loaded, false otherwise.
Constant Detail
XML_ELEMENT_NAMEConstant
public static const XML_ELEMENT_NAME:String = PropertyAction

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

The XML element name for property actions